autodoc/source/ary/idl/it_xnameroom.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ARY_IDL_IT_XNAMEROOM_HXX
  30 #define ARY_IDL_IT_XNAMEROOM_HXX
  31
  32 // BASE CLASSES
  33 #include <ary/idl/i_type.hxx>
  34 #include <nametreenode.hxx>
  35
  36
  37
  38
  39 namespace ary
  40 {
  41 namespace idl
  42 {
  43
  44
  45 /** A namespace for ->Type s, as they are explicitly written in code.
  46
  47     The search/identification string is usually the local name of
  48     the Type. But for templated structs, the search string has this
  49     pattern:
  50                 <LocalName> '<' <StringOfTemplateTypeId>
  51 */
  52 class ExplicitNameRoom : public Type
  53 {
  54   public:
  55     enum E_ClassId { class_id = 2204 };
  56
  57     // LIFECYCLE
  58                         ExplicitNameRoom();
  59                         ExplicitNameRoom(
  60                             const String &      i_sName,
  61                             const ExplicitNameRoom &
  62                                                 i_rParent );
  63     virtual             ~ExplicitNameRoom();
  64
  65     // OPERATIONS
  66     /** @param i_sSearchString
  67                 A local type name  usually.
  68                 For templated types see class docu.
  69         @see ExplicitNameRoom
  70     */
  71     void                Add_Name(
  72                             const String &      i_sSearchString,
  73                             Type_id             i_nId )
  74                             { aImpl.Add_Name(i_sSearchString,i_nId); }
  75     // INQUIRY
  76     const String &      Name() const            { return aImpl.Name(); }
  77     intt                Depth() const           { return aImpl.Depth(); }
  78     void                Get_FullName(
  79                             StringVector &      o_rText,
  80                             Ce_idList *         o_pRelatedCes,
  81                             const Gate &        i_rGate ) const;
  82     bool                IsAbsolute() const      { return Depth() > 0
  83                                                     ?   (*NameChain_Begin()).empty()
  84                                                     :   false; }
  85     /** @param i_sSearchString
  86                 A local type name  usually.
  87                 For templated types see class docu.
  88         @see ExplicitNameRoom
  89     */
  90     Type_id             Search_Name(
  91                             const String &      i_sSearchString ) const
  92                             { return aImpl.Search_Name(i_sSearchString); }
  93
  94     StringVector::const_iterator
  95                         NameChain_Begin() const
  96                             { return aImpl.NameChain_Begin(); }
  97     StringVector::const_iterator
  98                         NameChain_End() const
  99                             { return aImpl.NameChain_End(); }
 100   private:
 101     // Interface csv::ConstProcessorClient:
 102     virtual void        do_Accept(
 103                             csv::ProcessorIfc & io_processor ) const;
 104     // Interface Object:
 105     virtual ClassId     get_AryClass() const;
 106
 107     // Interface Type:
 108     virtual void        inq_Get_Text(
 109                             StringVector &      o_module,
 110                             String &            o_name,
 111                             Ce_id &             o_nRelatedCe,
 112                             int &               o_nSequemceCount,
 113                             const Gate &        i_rGate ) const;
 114     // DATA
 115     NameTreeNode<Type_id>
 116                         aImpl;
 117 };
 118
 119
 120
 121
 122 }   // namespace idl
 123 }   // namespace ary
 124 #endif
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */