soltools/inc/gen_info.hxx

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