autodoc/inc/ary/loc/loc_dir.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: loc_dir.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_LOC_DIR_HXX
  32 #define ARY_LOC_DIR_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/loc/loc_le.hxx>
  36
  37 // USED SERVICES
  38 #include <ary/loc/loc_traits.hxx>
  39 #include <ary/symtreenode.hxx>
  40
  41 namespace ary
  42 {
  43 namespace loc
  44 {
  45     class File;
  46 }
  47 }
  48
  49
  50
  51
  52 namespace ary
  53 {
  54 namespace loc
  55 {
  56
  57
  58 /** Represents a directory for source code files.
  59 */
  60 class Directory : public LocationEntity
  61 {
  62   public:
  63     enum E_ClassId { class_id = 7030 };
  64
  65     typedef ::ary::symtree::Node<LeNode_Traits>    node_t;
  66
  67     /// Used for root directories.
  68     explicit                Directory(
  69                             Le_id               i_assignedRoot );
  70
  71     /// Used for subdirectories which have a parent directory.
  72                         Directory(
  73                             const String  &     i_localName,
  74                             Le_id               i_parentDirectory );
  75     virtual                         ~Directory();
  76
  77     void                Add_Dir(
  78                             const Directory  &  i_dir );
  79     void                Add_File(
  80                             const File &        i_file );
  81
  82     Le_id               Parent() const;
  83     Le_id               AssignedRoot() const;
  84
  85     Le_id               Search_Dir(
  86                             const String &      i_name ) const;
  87     Le_id               Search_File(
  88                             const String &      i_name ) const;
  89
  90     const node_t &      AsNode() const;
  91     node_t &            AsNode();
  92
  93   private:
  94     struct Container;
  95
  96     // Interface csv::ConstProcessorClient:
  97     virtual void        do_Accept(
  98                             csv::ProcessorIfc & io_processor ) const;
  99     // Interface ary::Object:
 100     virtual ClassId     get_AryClass() const;
 101
 102     // Interface LocationEntity:
 103     virtual const String &
 104                         inq_LocalName() const;
 105     virtual Le_id       inq_ParentDirectory() const;
 106
 107     // DATA
 108     String              sLocalName;
 109     Le_id               nParentDirectory;
 110     Le_id               nAssignedRoot;
 111     node_t              aAssignedNode;
 112     Dyn<Container>      pChildren;
 113 };
 114
 115
 116
 117
 118 // IMPLEMENTATION
 119 inline Le_id
 120 Directory::Parent() const
 121 {
 122     return nParentDirectory;
 123 }
 124
 125 inline Le_id
 126 Directory::AssignedRoot() const
 127 {
 128     return nAssignedRoot;
 129 }
 130
 131 inline const Directory::node_t &
 132 Directory::AsNode() const
 133 {
 134     return aAssignedNode;
 135 }
 136
 137 inline Directory::node_t &
 138 Directory::AsNode()
 139 {
 140     return aAssignedNode;
 141 }
 142
 143
 144
 145
 146 } // namespace loc
 147 } // namespace ary
 148 #endif