autodoc/source/ary/idl/it_xnameroom.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: it_xnameroom.hxx,v $
  10  * $Revision: 1.5 $
  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 ARY_IDL_IT_XNAMEROOM_HXX
  32 #define ARY_IDL_IT_XNAMEROOM_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_type.hxx>
  36 #include <nametreenode.hxx>
  37
  38
  39
  40
  41 namespace ary
  42 {
  43 namespace idl
  44 {
  45
  46
  47 /** A namespace for ->Type s, as they are explicitely written in code.
  48
  49     The search/identification string is usually the local name of
  50     the Type. But for templated structs, the search string has this
  51     pattern:
  52                 <LocalName> '<' <StringOfTemplateTypeId>
  53 */
  54 class ExplicitNameRoom : public Type
  55 {
  56   public:
  57     enum E_ClassId { class_id = 2204 };
  58
  59     // LIFECYCLE
  60                         ExplicitNameRoom();
  61                         ExplicitNameRoom(
  62                             const String &      i_sName,
  63                             const ExplicitNameRoom &
  64                                                 i_rParent );
  65     virtual             ~ExplicitNameRoom();
  66
  67     // OPERATIONS
  68     /** @param i_sSearchString
  69                 A local type name  usually.
  70                 For templated types see class docu.
  71         @see ExplicitNameRoom
  72     */
  73     void                Add_Name(
  74                             const String &      i_sSearchString,
  75                             Type_id             i_nId )
  76                             { aImpl.Add_Name(i_sSearchString,i_nId); }
  77     // INQUIRY
  78     const String &      Name() const            { return aImpl.Name(); }
  79     intt                Depth() const           { return aImpl.Depth(); }
  80     void                Get_FullName(
  81                             StringVector &      o_rText,
  82                             Ce_idList *         o_pRelatedCes,
  83                             const Gate &        i_rGate ) const;
  84     bool                IsAbsolute() const      { return Depth() > 0
  85                                                     ?   (*NameChain_Begin()).empty()
  86                                                     :   false; }
  87     /** @param i_sSearchString
  88                 A local type name  usually.
  89                 For templated types see class docu.
  90         @see ExplicitNameRoom
  91     */
  92     Type_id             Search_Name(
  93                             const String &      i_sSearchString ) const
  94                             { return aImpl.Search_Name(i_sSearchString); }
  95
  96     StringVector::const_iterator
  97                         NameChain_Begin() const
  98                             { return aImpl.NameChain_Begin(); }
  99     StringVector::const_iterator
 100                         NameChain_End() const
 101                             { return aImpl.NameChain_End(); }
 102   private:
 103     // Interface csv::ConstProcessorClient:
 104     virtual void        do_Accept(
 105                             csv::ProcessorIfc & io_processor ) const;
 106     // Interface Object:
 107     virtual ClassId     get_AryClass() const;
 108
 109     // Interface Type:
 110     virtual void        inq_Get_Text(
 111                             StringVector &      o_module,
 112                             String &            o_name,
 113                             Ce_id &             o_nRelatedCe,
 114                             int &               o_nSequemceCount,
 115                             const Gate &        i_rGate ) const;
 116     // DATA
 117     NameTreeNode<Type_id>
 118                         aImpl;
 119 };
 120
 121
 122
 123
 124 }   // namespace idl
 125 }   // namespace ary
 126 #endif