soltools/inc/gilacces.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: gilacces.hxx,v $
  10  * $Revision: 1.3 $
  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 SOLTOOLS_GILACCES_HXX
  32 #define SOLTOOLS_GILACCES_HXX
  33
  34
  35
  36 class GenericInfoParseTypes
  37 {
  38   public:
  39     enum E_Error
  40     {
  41         ok = 0,
  42         cannot_open,
  43         unexpected_eof,
  44         syntax_error,
  45         unexpected_list_end
  46     };
  47 };
  48
  49
  50
  51 /** This class is an abstract interface for a service, which
  52     builds a memory structure out of a generic information
  53     structure, read from a file or other stream.
  54
  55     There may be different implementations, which build different kinds
  56     of memory structures.
  57 */
  58 class GenericInfoList_Builder
  59 {
  60   public:
  61     typedef unsigned long   UINT32;
  62
  63     virtual             ~GenericInfoList_Builder() {}
  64
  65     virtual void        AddKey(
  66                             const char *        i_sKey,
  67                             UINT32              i_nKeyLength,
  68                             const char *        i_sValue,
  69                             UINT32              i_nValueLength,
  70                             const char *        i_sComment,
  71                             UINT32              i_nCommentLength ) = 0;
  72
  73     virtual void        OpenList() = 0;
  74     virtual void        CloseList() = 0;
  75 };
  76
  77
  78 /** This class is an abstract interface for a service, which
  79     returns the values of a generic information tree out of
  80     a memory structure.
  81
  82     There may be different implementations, which browse different
  83     kinds of memory structures.
  84 */
  85 class GenericInfoList_Browser
  86 {
  87   public:
  88     virtual             ~GenericInfoList_Browser() {}
  89
  90     virtual bool        Start_CurList() = 0;
  91     virtual bool        NextOf_CurList() = 0;
  92
  93     virtual void        Get_CurKey(
  94                             char *              o_rKey ) const = 0;
  95     virtual void        Get_CurValue(
  96                             char *              o_rValue ) const = 0;
  97     virtual void        Get_CurComment(
  98                             char *              o_rComment ) const = 0;
  99     virtual bool        HasSubList_CurKey() const = 0;
 100
 101     virtual void        Push_CurList() = 0;
 102     virtual void        Pop_CurList() = 0;
 103 };
 104
 105
 106 #endif
 107