xref: /aoo4110/main/soltools/inc/gilacces.hxx (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski 
24*b1cdbd2cSJim Jagielski #ifndef SOLTOOLS_GILACCES_HXX
25*b1cdbd2cSJim Jagielski #define SOLTOOLS_GILACCES_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski 
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski class GenericInfoParseTypes
30*b1cdbd2cSJim Jagielski {
31*b1cdbd2cSJim Jagielski   public:
32*b1cdbd2cSJim Jagielski     enum E_Error
33*b1cdbd2cSJim Jagielski     {
34*b1cdbd2cSJim Jagielski         ok = 0,
35*b1cdbd2cSJim Jagielski         cannot_open,
36*b1cdbd2cSJim Jagielski         unexpected_eof,
37*b1cdbd2cSJim Jagielski         syntax_error,
38*b1cdbd2cSJim Jagielski         unexpected_list_end
39*b1cdbd2cSJim Jagielski     };
40*b1cdbd2cSJim Jagielski };
41*b1cdbd2cSJim Jagielski 
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski 
44*b1cdbd2cSJim Jagielski /** This class is an abstract interface for a service, which
45*b1cdbd2cSJim Jagielski     builds a memory structure out of a generic information
46*b1cdbd2cSJim Jagielski     structure, read from a file or other stream.
47*b1cdbd2cSJim Jagielski 
48*b1cdbd2cSJim Jagielski     There may be different implementations, which build different kinds
49*b1cdbd2cSJim Jagielski     of memory structures.
50*b1cdbd2cSJim Jagielski */
51*b1cdbd2cSJim Jagielski class GenericInfoList_Builder
52*b1cdbd2cSJim Jagielski {
53*b1cdbd2cSJim Jagielski   public:
54*b1cdbd2cSJim Jagielski     typedef unsigned long   UINT32;
55*b1cdbd2cSJim Jagielski 
~GenericInfoList_Builder()56*b1cdbd2cSJim Jagielski     virtual             ~GenericInfoList_Builder() {}
57*b1cdbd2cSJim Jagielski 
58*b1cdbd2cSJim Jagielski     virtual void        AddKey(
59*b1cdbd2cSJim Jagielski                             const char *        i_sKey,
60*b1cdbd2cSJim Jagielski                             UINT32              i_nKeyLength,
61*b1cdbd2cSJim Jagielski                             const char *        i_sValue,
62*b1cdbd2cSJim Jagielski                             UINT32              i_nValueLength,
63*b1cdbd2cSJim Jagielski                             const char *        i_sComment,
64*b1cdbd2cSJim Jagielski                             UINT32              i_nCommentLength ) = 0;
65*b1cdbd2cSJim Jagielski 
66*b1cdbd2cSJim Jagielski     virtual void        OpenList() = 0;
67*b1cdbd2cSJim Jagielski     virtual void        CloseList() = 0;
68*b1cdbd2cSJim Jagielski };
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski /** This class is an abstract interface for a service, which
72*b1cdbd2cSJim Jagielski     returns the values of a generic information tree out of
73*b1cdbd2cSJim Jagielski     a memory structure.
74*b1cdbd2cSJim Jagielski 
75*b1cdbd2cSJim Jagielski     There may be different implementations, which browse different
76*b1cdbd2cSJim Jagielski     kinds of memory structures.
77*b1cdbd2cSJim Jagielski */
78*b1cdbd2cSJim Jagielski class GenericInfoList_Browser
79*b1cdbd2cSJim Jagielski {
80*b1cdbd2cSJim Jagielski   public:
~GenericInfoList_Browser()81*b1cdbd2cSJim Jagielski     virtual             ~GenericInfoList_Browser() {}
82*b1cdbd2cSJim Jagielski 
83*b1cdbd2cSJim Jagielski     virtual bool        Start_CurList() = 0;
84*b1cdbd2cSJim Jagielski     virtual bool        NextOf_CurList() = 0;
85*b1cdbd2cSJim Jagielski 
86*b1cdbd2cSJim Jagielski     virtual void        Get_CurKey(
87*b1cdbd2cSJim Jagielski                             char *              o_rKey ) const = 0;
88*b1cdbd2cSJim Jagielski     virtual void        Get_CurValue(
89*b1cdbd2cSJim Jagielski                             char *              o_rValue ) const = 0;
90*b1cdbd2cSJim Jagielski     virtual void        Get_CurComment(
91*b1cdbd2cSJim Jagielski                             char *              o_rComment ) const = 0;
92*b1cdbd2cSJim Jagielski     virtual bool        HasSubList_CurKey() const = 0;
93*b1cdbd2cSJim Jagielski 
94*b1cdbd2cSJim Jagielski     virtual void        Push_CurList() = 0;
95*b1cdbd2cSJim Jagielski     virtual void        Pop_CurList() = 0;
96*b1cdbd2cSJim Jagielski };
97*b1cdbd2cSJim Jagielski 
98*b1cdbd2cSJim Jagielski 
99*b1cdbd2cSJim Jagielski #endif
100*b1cdbd2cSJim Jagielski 
101