autodoc/inc/ary/idl/i_module.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: i_module.hxx,v $
  10  * $Revision: 1.4 $
  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_I_MODULE_HXX
  32 #define ARY_IDL_I_MODULE_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/stdconstiter.hxx>
  39
  40
  41
  42
  43 namespace ary
  44 {
  45     template <class> class NameTreeNode;
  46
  47 namespace idl
  48 {
  49 namespace ifc_module
  50 {
  51     struct attr;
  52 }
  53     class Gate;
  54
  55
  56 /** Represents an IDL module.
  57
  58     "Name" in methods means all code entities which belong into
  59     this namespace (not in a subnamespace of this one), but not
  60     to the subnamespaces.
  61
  62     "SubNamespace" in method names refers to all direct subnamespaces.
  63 */
  64 class Module : public CodeEntity
  65 {
  66   public:
  67     enum E_ClassId { class_id = 2000 };
  68
  69         // LIFECYCLE
  70                         Module();
  71                         Module(
  72                             const String &      i_sName,
  73                             const Module &      i_rParent );
  74                         ~Module();
  75     // OPERATIONS
  76     void                Add_Name(
  77                             const String &      i_sName,
  78                             Ce_id               i_nId );
  79     // INQUIRY
  80     Ce_id               Search_Name(
  81                             const String &      i_sName ) const;
  82     void                Get_Names(
  83                             Dyn_StdConstIterator<Ce_id> &
  84                                                 o_rResult ) const;
  85   private:
  86     // Interface csv::ConstProcessorClient:
  87     virtual void        do_Accept(
  88                             csv::ProcessorIfc & io_processor ) const;
  89     // Interface ary::Object:
  90     virtual ClassId     get_AryClass() const;
  91
  92     // Interface CodeEntity
  93     virtual const String &  inq_LocalName() const;
  94     virtual Ce_id           inq_NameRoom() const;
  95     virtual Ce_id           inq_Owner() const;
  96     virtual E_SightLevel    inq_SightLevel() const;
  97
  98     friend struct ifc_module::attr;
  99
 100     // DATA
 101     Dyn< NameTreeNode<Ce_id> >
 102                             pImpl;
 103 };
 104
 105
 106 inline bool
 107 is_Module( const CodeEntity & i_rCe )
 108 {
 109     return i_rCe.AryClass() == Module::class_id;
 110 }
 111
 112
 113
 114
 115 }   // namespace idl
 116 }   // namespace ary
 117 #endif