configmgr/source/inc/treefragment.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: treefragment.hxx,v $
  10  * $Revision: 1.8 $
  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 INCLUDED_SHARABLE_TREEFRAGMENT_HXX
  32 #define INCLUDED_SHARABLE_TREEFRAGMENT_HXX
  33
  34 #include "flags.hxx"
  35 #include "node.hxx"
  36
  37 namespace configmgr
  38 {
  39 //-----------------------------------------------------------------------------
  40     namespace sharable
  41     {
  42     //-----------------------------------------------------------------------------
  43     /* a TreeFragment header is interpreted differently, depending on the kind of TreeFragment
  44
  45          - for a set element
  46              name points to the element name (the name in the root node is the template name)
  47              parent  points to the SetNode that is the parent. The containing treefragment can
  48                      be recovered from this with some care
  49              next points to the next element of the same set. It is null for the last element.
  50              state is fully used here
  51
  52          - for a template tree
  53              name points to the template name (same as the name in the root node)
  54              component points to the home component name of the template
  55                         (often the same as 'component' in the component tree)
  56              next points to another template TreeFragment. It is null for the last template.
  57              state must be 'replaced' here (rarely it might be marked as mandatory)
  58
  59          - for a component tree
  60              name points to the component name (same as the name in the root node)
  61              component is equal to name (or NULL ?)
  62              next points to another template TreeFragment. It is null if there is no template.
  63              state must be either 'defaulted' or 'merged'
  64                    (it should be marked as mandatory although that is not used yet)
  65     */
  66         struct TreeFragmentHeader
  67         {
  68             struct TreeFragment *next;       // next sibling set element or template
  69             rtl_uString *               name;       // element-name/template name
  70             union // context
  71             {
  72                 union Node *parent;          // parent node
  73                 rtl_uString *      component;       // component name
  74             };
  75             sal_uInt16               count;      // number of contained nodes
  76             sal_uInt8         state;
  77             sal_uInt8            reserved;
  78        };
  79     //-----------------------------------------------------------------------------
  80     /* a tree fragment is stored as a variable-sized struct
  81        containing a header and a fixed sequence of nodes
  82
  83         R - - A - - A1
  84            |     |
  85            |      - A2
  86            |
  87             - B
  88            |
  89             - C - - C1 - - C11
  90            |     |      |
  91            |     |       - C12
  92            |     |
  93            |      - C2 - - C21
  94            |
  95             - D
  96
  97       is stored as
  98
  99           H(count = 12) : [R;A;A1;A2;B;C;C1;C11;C12;C2;C21;D]
 100     */
 101     //-----------------------------------------------------------------------------
 102     /* tree fragments are used for: Component trees, Template trees, Set elements
 103
 104         They are only fragments, as for a TreeFragment a Set is considered a leaf node.
 105         Set elements are maintained as a singly linked list that is accessible from the set node
 106
 107         A cache component has the Root (component tree) TreeFragment at a well-known location.
 108         The 'next' element of the component tree points to the list of template TreeFragments
 109         used in the component.
 110     */
 111         struct TreeFragment
 112         {
 113             TreeFragmentHeader  header;     // really variable-sized:
 114             Node                nodes[1];   //   nodes[header.count]
 115
 116             // header info access
 117             bool hasDefaultsAvailable() const;
 118
 119             bool isDefault() const;
 120             bool isNew() const;
 121
 122             bool isNamed(rtl::OUString const & _aName) const;
 123
 124             rtl::OUString               getName() const;
 125
 126             void setName(rtl::OUString const & name);
 127
 128             configmgr::node::Attributes getAttributes()const;
 129
 130             Node * getRootNode() { return nodes; }
 131
 132             static TreeFragment *allocate(sal_uInt32 nFragments);
 133             static void free_shallow( TreeFragment *pFragment );
 134         };
 135     //-----------------------------------------------------------------------------
 136
 137     }
 138 //-----------------------------------------------------------------------------
 139 }
 140
 141 #endif // INCLUDED_SHARABLE_TREEFRAGMENT_HXX