Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef ARY_IDL_I_CE_HXX
      21             : #define ARY_IDL_I_CE_HXX
      22             : 
      23             : // BASE CLASSES
      24             : #include <ary/entity.hxx>
      25             : // USED SERVICES
      26             : #include <ary/doc/d_docu.hxx>
      27             : #include <ary/idl/i_ce2s.hxx>
      28             : #include <ary/idl/i_types4idl.hxx>
      29             : 
      30             : 
      31             : 
      32             : 
      33             : 
      34             : 
      35             : namespace ary
      36             : {
      37             : namespace idl
      38             : {
      39             : 
      40             : 
      41             : /** @resp Base class for all IDL code entities.
      42             : 
      43             :     A @->CodeEntity is a namespace, type, data or function, which occures in
      44             :     the parsed UNO IDL code and is described and/or commented within the
      45             :     Autodoc repository.
      46             : 
      47             :     This is a storage base class, where more special classes are
      48             :     derived from.
      49             : */
      50             : class CodeEntity : public ary::Entity
      51             : {
      52             :   public:
      53             :     // LIFECYCLE
      54             :     virtual             ~CodeEntity();
      55             : 
      56             :     // OPERATION
      57             : 
      58             :     // INQUIRY
      59      142602 :     Ce_id               CeId() const            { return Ce_id(Id()); }
      60             :     const String &      LocalName() const;
      61             :     Ce_id               NameRoom() const;
      62             :     Ce_id               Owner() const;
      63             :     E_SightLevel        SightLevel() const;
      64             : 
      65             :     const ary::doc::Documentation &
      66             :                         Docu() const;
      67             :     const Ce_2s &       Secondaries() const;
      68             : 
      69             :     static const CodeEntity &
      70             :                         Null_();
      71             :     // ACCESS
      72             :     void                Set_Docu(
      73             :                             DYN ary::doc::Node &
      74             :                                                 pass_data );
      75             :     Ce_2s &             Secondaries();
      76             : 
      77             :   protected:
      78             :                         CodeEntity();
      79             :   private:
      80             :     // Locals
      81             :     virtual const String &  inq_LocalName() const = 0;
      82             :     virtual Ce_id           inq_NameRoom() const = 0;
      83             :     virtual Ce_id           inq_Owner() const = 0;
      84             :     virtual E_SightLevel    inq_SightLevel() const = 0;
      85             : 
      86             :     // DATA
      87             :     ary::doc::Documentation
      88             :                         aDocu;
      89             :     Dyn<Ce_2s>          p2s;
      90             : };
      91             : 
      92             : 
      93             : 
      94             : 
      95             : // IMPLEMENTATION
      96             : inline const String &
      97     1836596 : CodeEntity::LocalName() const
      98     1836596 :     { return inq_LocalName(); }
      99             : 
     100             : inline Ce_id
     101      922686 : CodeEntity::NameRoom() const
     102      922686 :     { return inq_NameRoom(); }
     103             : 
     104             : inline Ce_id
     105      122371 : CodeEntity::Owner() const
     106      122371 :     { return inq_Owner(); }
     107             : 
     108             : inline E_SightLevel
     109      126020 : CodeEntity::SightLevel() const
     110      126020 :     { return inq_SightLevel(); }
     111             : 
     112             : inline const ary::doc::Documentation &
     113       62341 : CodeEntity::Docu() const
     114       62341 :     { return aDocu; }
     115             : 
     116             : inline void
     117       16643 : CodeEntity::Set_Docu(DYN ary::doc::Node & pass_data)
     118             : {
     119       16643 :     aDocu.Set_Data(pass_data);
     120       16643 : }
     121             : 
     122             : 
     123             : 
     124             : 
     125             : }   // namespace idl
     126             : }   // namespace ary
     127             : #endif
     128             : 
     129             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */