soltools/inc/gen_info.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: gen_info.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef GEN_INFO_HXX
  32 #define GEN_INFO_HXX
  33
  34
  35 #include "simstr.hxx"
  36 #include <string.h>
  37
  38
  39
  40 class List_GenericInfo;
  41
  42
  43 /** Holds generic informations in a simple hierarchical format.
  44 */
  45 class GenericInfo
  46 {
  47   public:
  48     // LIFECFYCLE
  49                         GenericInfo(
  50                             const Simstr &      i_sKey,
  51                             const Simstr &      i_sValue = Simstr::null_(),
  52                             const Simstr &      i_sComment = Simstr::null_() );
  53                         GenericInfo(
  54                             const GenericInfo & i_rInfo );
  55                         ~GenericInfo();
  56
  57     // OPERATORS
  58     GenericInfo &       operator=(
  59                             const GenericInfo & i_rInfo );
  60     bool                operator<(
  61                             const GenericInfo & i_rInfo ) const
  62 #ifdef UNX
  63                                                 { return strcasecmp(sKey.str(),i_rInfo.sKey.str()) < 0; }
  64 #else
  65                                                 { return stricmp(sKey.str(),i_rInfo.sKey.str()) < 0; }
  66 #endif
  67     // INFO
  68     const Simstr &      Key() const             { return sKey; }
  69     const Simstr &      Value() const           { return sValue; }
  70     const Simstr &      Comment() const         { return sComment; }
  71     bool                HasSubList() const      { return dpSubList != 0; }
  72
  73     const List_GenericInfo &
  74                         SubList() const         { return HasSubList() ? *dpSubList : CreateMyList(); }
  75     // ACCESS
  76     List_GenericInfo &
  77                         SubList()               { return HasSubList() ? *dpSubList : CreateMyList(); }
  78
  79   private:
  80     /// @precond dpSubList == 0 .
  81     List_GenericInfo &  CreateMyList() const;
  82
  83     // DATA
  84     Simstr              sKey;
  85     Simstr              sValue;
  86     Simstr              sComment;
  87     List_GenericInfo *  dpSubList;      /// Owned by this object.
  88 };
  89
  90
  91 #endif
  92