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