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