xml2cmp/source/xcd/xmlelem.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: xmlelem.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 X2C_XMLELEM_HXX
  32 #define X2C_XMLELEM_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38     // COMPONENTS
  39 #include "../support/sistr.hxx"
  40 #include "../support/list.hxx"
  41 #include "../support/syshelp.hxx"
  42     // PARAMETERS
  43
  44
  45 class X2CParser;
  46 class HtmlCreator;
  47 class Index;
  48
  49 class XmlElement
  50 {
  51   public:
  52     virtual                             ~XmlElement() {}
  53     virtual void        Parse(
  54                             X2CParser &                 io_rParser ) = 0;
  55     virtual void        Write2Html(
  56                             HtmlCreator &               io_rHC ) const = 0;
  57     virtual void        Insert2Index(
  58                             Index &             o_rIndex ) const;                       // Default: Does nothing, but can be overwritten.
  59
  60 //      virtual void        Put2Dependy() = 0;
  61
  62     const Simstr &              Name() const                    { return sName; }
  63
  64   protected:
  65                         XmlElement(
  66                             const char *                i_sName );
  67   private:
  68     Simstr                              sName;
  69 };
  70
  71
  72 class MultipleElement : public XmlElement
  73 {
  74   public:
  75                         ~MultipleElement();
  76
  77     virtual XmlElement *
  78                         FindChild(
  79                             const Simstr &              i_sChildName );
  80
  81
  82   protected:
  83     typedef DynamicList<XmlElement>                     ChildList;
  84
  85                         MultipleElement(
  86                             const char *                i_sName );
  87
  88     void                                AddChild(
  89                             XmlElement &                let_drElement );
  90
  91     const ChildList &   Children() const                { return aChildren; }
  92     ChildList &                 Children()                              { return aChildren; }
  93
  94   private:
  95     ChildList                   aChildren;
  96 };
  97
  98 class SequenceElement : public MultipleElement
  99 {
 100   public:
 101     virtual void        Parse(
 102                             X2CParser &                 io_rParser );
 103     virtual void        Write2Html(
 104                             HtmlCreator &               io_rHC ) const;
 105
 106   protected:
 107                         SequenceElement(
 108                             const char *                i_sName,
 109                             unsigned            i_nIndexNameElement = 0 );
 110   private:
 111     unsigned                    nIndexNameElement;
 112 };
 113
 114 class FreeChoiceElement : public MultipleElement
 115 {
 116   public:
 117                         FreeChoiceElement();
 118     using                               MultipleElement::AddChild;
 119
 120     virtual void        Parse(
 121                             X2CParser &                 io_rParser );
 122     virtual void        Write2Html(
 123                             HtmlCreator &               io_rHC ) const;
 124 };
 125
 126 class ListElement : public MultipleElement
 127 {
 128   public:
 129     typedef XmlElement * (*F_CREATE)(const Simstr &);
 130
 131                         ListElement(
 132                             const char *                i_sElementsName,
 133                             F_CREATE            i_fCreateNewElement );
 134
 135     virtual void        Parse(
 136                             X2CParser &                 io_rParser );
 137     virtual void        Write2Html(
 138                             HtmlCreator &               io_rHC ) const;
 139     virtual XmlElement *
 140                         Create_and_Add_NewElement();
 141   private:
 142     F_CREATE                    fCreateNewElement;
 143 };
 144
 145 class TextElement : public XmlElement
 146 {
 147   public:
 148     E_LinkType                  LinkType() const                { return eLinkType; }
 149     bool                            IsReversedName() const      { return bReverseName; }
 150   protected:
 151                         TextElement(
 152                             const char *                i_sName,
 153                             E_LinkType                  i_eLinkType,
 154                             bool                                i_bReverseName );
 155   private:
 156     E_LinkType                  eLinkType;
 157     bool                                bReverseName;
 158 };
 159
 160 class SglTextElement : public TextElement
 161 {
 162   public:
 163                         SglTextElement(
 164                             const char *                i_sName,
 165                             E_LinkType                  i_eLinkType,
 166                             bool                                i_bReverseName );
 167
 168     virtual void        Parse(
 169                             X2CParser &                 io_rParser );
 170     virtual void        Write2Html(
 171                             HtmlCreator &               io_rHC ) const;
 172     virtual const Simstr &
 173                         Data() const                    { return sContent; }
 174   private:
 175     Simstr                              sContent;
 176 };
 177
 178 class MultipleTextElement : public TextElement
 179 {
 180   public:
 181                         MultipleTextElement(
 182                             const char *                i_sName,
 183                             E_LinkType                  i_eLinkType,
 184                             bool                                i_bReverseName );
 185
 186     virtual void        Parse(
 187                             X2CParser &                 io_rParser );
 188     virtual void        Write2Html(
 189                             HtmlCreator &               io_rHC ) const;
 190     virtual const Simstr &
 191                         Data(
 192                             unsigned                    i_nNr ) const;
 193     virtual unsigned    Size() const                    { return aContent.size(); }
 194
 195   private:
 196     List<Simstr>                aContent;
 197 };
 198
 199 class EmptyElement : public XmlElement
 200 {
 201   protected:
 202                         EmptyElement(
 203                             const char *                i_sName );
 204 };
 205
 206 class SglAttrElement : public EmptyElement
 207 {
 208   public:
 209                         SglAttrElement(
 210                             const char *                i_sName,
 211                             const char *                i_sAttrName );
 212
 213     virtual void        Parse(
 214                             X2CParser &                 io_rParser );
 215     virtual void        Write2Html(
 216                             HtmlCreator &               io_rHC ) const;
 217   private:
 218     Simstr                              sAttrName;
 219     Simstr                              sAttrValue;
 220 };
 221
 222
 223 class MultipleAttrElement : public EmptyElement
 224 {
 225   public:
 226                         MultipleAttrElement(
 227                             const char *                i_sName,
 228                             const char **               i_sAttrNames,
 229                             unsigned                    i_nSize );
 230
 231     virtual void        Parse(
 232                             X2CParser &                 io_rParser );
 233     virtual void        Write2Html(
 234                             HtmlCreator &               io_rHC ) const;
 235   private:
 236     List<Simstr>                aAttrNames;
 237     List<Simstr>                aAttrValues;
 238 };
 239
 240 // IMPLEMENTATION
 241
 242
 243 #endif
 244