tools/inc/bootstrp/mkcreate.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: mkcreate.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 _MK_CREATE_HXX
  32 #define _MK_CREATE_HXX
  33
  34 #include <tools/string.hxx>
  35 #include "bootstrp/sstring.hxx"
  36
  37 #include <tools/list.hxx>
  38 #include "bootstrp/prj.hxx"
  39
  40 class SvStream;
  41 class SourceDirectoryList;
  42
  43 //
  44 // class SourceDirectoryDependency
  45 //
  46
  47 class CodedDependency : public ByteString
  48 {
  49 private:
  50     USHORT nOSType;                                                     // operating systems where dependeny exists
  51
  52 public:
  53     /* create a dependency instance with given coded directory name
  54      */
  55     CodedDependency(
  56         const ByteString &rCodedIdentifier, // the coded name of the directory
  57         USHORT nOperatingSystems                        // the operating systems where this dependency exists
  58     ) :
  59     ByteString( rCodedIdentifier ),
  60     nOSType( nOperatingSystems )
  61     {
  62     }
  63
  64     /* returns the operating system
  65      */
  66     USHORT GetOperatingSystem()
  67     {
  68         return nOSType;
  69     }
  70
  71     /* set operating system
  72      */
  73     void SetOperatingSystem( USHORT nOperatingSystems )
  74     {
  75         nOSType = nOperatingSystems;
  76     }
  77
  78     /* add operating systems if same dependency
  79      */
  80     BOOL TryToMerge(
  81         const ByteString &rCodedIdentifier, // the coded name of the directory
  82         USHORT nOperatingSystems                        // the operating systems where this dependency exists
  83     )
  84     {
  85         if ( rCodedIdentifier != *this )
  86             return FALSE;
  87         nOSType |= nOperatingSystems;
  88         return TRUE;
  89     }
  90 };
  91
  92 //
  93 // class Dependecy
  94 //
  95
  96 class Dependency : public ByteString
  97 {
  98 private:
  99     USHORT nOSType;                                                     // operating systems where dependecy exists
 100
 101 public:
 102     /* create a dependency instance with given directory name
 103      */
 104     Dependency(
 105         const ByteString &rDirectoryName,       // the coded name of the directory
 106         USHORT nOperatingSystems                        // the operating systems where this dependency exists
 107     ) :
 108     ByteString( rDirectoryName ),
 109     nOSType( nOperatingSystems )
 110     {
 111     }
 112
 113     /* returns the operating system
 114      */
 115     USHORT GetOperatingSystem()
 116     {
 117         return nOSType;
 118     }
 119 };
 120
 121 //
 122 // class SourceDirectory
 123 //
 124
 125 class SourceDirectory : public ByteString
 126 {
 127 private:
 128     SourceDirectory *pParent;                           // the parent directory
 129     SourceDirectoryList *pSubDirectories;       // list of sub directories
 130     USHORT nOSType;                                                     // operating systems where this directory is used
 131     USHORT nDepth;                                                      // depth of directory structure (root is 0)
 132
 133     SByteStringList *pDependencies;                     // dependencies on other directories in this depth
 134
 135     SByteStringList *pCodedDependencies;        // dependencies on other directories in different depth
 136     SByteStringList *pCodedIdentifier;          // symbolic identifier to resolve dependencies
 137
 138     /* try to resolve a single dependency
 139      */
 140     Dependency *ResolvesDependency(
 141         CodedDependency *pCodedDependency       // the dependency
 142     );
 143
 144     /* returns the operating systems of a coded dependency
 145      */
 146     static USHORT GetOSType(
 147         const ByteString &sDependExt            // the corresponding dependency extension (see also prj.hxx)
 148     );
 149
 150     /* removes this and all sub directories with all dependencies
 151      */
 152     BOOL RemoveDirectoryTreeAndAllDependencies();
 153
 154 public:
 155
 156     /* create a directory instance with given parent and name, no parent means this is the root
 157      * (not the file system root but the root of the source tree, e.g. o:\569)
 158      */
 159     SourceDirectory(
 160         const ByteString &rDirectoryName,                       // name without parent
 161         USHORT nOperatingSystem,                                        // the operating systems where this directory is used
 162         SourceDirectory *pParentDirectory = NULL        // parent (if not root)
 163     );
 164     ~SourceDirectory();
 165
 166     /* returns the full absolute path of this directory
 167      */
 168     ByteString GetFullPath();
 169
 170     /* returns a list of all sub directories
 171      */
 172     SourceDirectoryList *GetSubDirectories() { return pSubDirectories; }
 173
 174     /* returns the Operating systems where this directory is used
 175      */
 176     USHORT GetOperatingSystems() { return nOSType; }
 177
 178     /* returns the given directory
 179      */
 180     SourceDirectory *GetDirectory(
 181         const ByteString &rDirectoryName,       // full path
 182         USHORT nOperatingSystem                         // the operating systems where this directory is used
 183     );
 184
 185     /* create the directory and all mandatory parents
 186      */
 187     SourceDirectory *InsertFull(
 188         const ByteString &rDirectoryName,       // full path
 189         USHORT nOperatingSystem                         // the operating systems where this directory is used
 190     )
 191     {
 192         return GetDirectory( rDirectoryName, nOperatingSystem );
 193     }
 194
 195     /* create the directory as sub directory of this directory
 196      */
 197     SourceDirectory *Insert(
 198         const ByteString &rDirectoryName,       // name without parent
 199         USHORT nOperatingSystem                         // the operating systems where this directory is used
 200     );
 201
 202     /* get the root directory
 203      */
 204     SourceDirectory *GetRootDirectory();
 205
 206     /* get sub directory if exists
 207      */
 208     SourceDirectory *GetSubDirectory(
 209         const ByteString &rDirectoryPath,       // full sub path
 210         USHORT nOperatingSystem                         // the operating systems where this directory is used
 211     );
 212
 213     /* add a dependency for several platforms
 214      */
 215     CodedDependency *AddCodedDependency(
 216         const ByteString &rCodedIdentifier, // the coded name of the directory
 217         USHORT nOperatingSystems                        // the operating systems where this dependency exists
 218     );
 219
 220     /* returns the dependency list
 221      */
 222     SByteStringList *GetCodedDependencies()
 223     {
 224         return pCodedDependencies;
 225     }
 226
 227     /* add symbolic identifier to resolve dependencies (to this directory and all parents)
 228      */
 229     CodedDependency *AddCodedIdentifier(
 230         const ByteString &rCodedIdentifier, // the coded name of the directory
 231         USHORT nOperatingSystems                        // the operating systems where this dependency exists
 232     );
 233
 234     /* returns the identifier list
 235      */
 236     SByteStringList *GetCodedIdentifier()
 237     {
 238         return pCodedIdentifier;
 239     }
 240
 241     /* create dependencies on other directory, coded dependecies are used
 242      */
 243     void ResolveDependencies();
 244
 245     /* returns the target definition for this directory (if dependencies exist)
 246      */
 247     ByteString GetTarget();
 248
 249     /* returns the target definition for all sub directory
 250      */
 251     ByteString GetSubDirsTarget();
 252
 253     /* create the full directory tree (only virtual, not in file system)
 254      */
 255     static SourceDirectory *CreateRootDirectory(
 256         const ByteString &rRoot,        // the root directory in file system
 257         const ByteString &rVersion,     // the solar verion (r.g. SRC590, SRC591 etc.)
 258         BOOL bAll = FALSE                       // add all directories or only buildable ones
 259     );
 260
 261     /* create the makefile.rc in file system
 262      */
 263     BOOL CreateRecursiveMakefile(
 264         BOOL bAllChilds = FALSE         // create rcursive for all sub directories
 265     );
 266 };
 267
 268 //
 269 // class SourceDirectoryList
 270 //
 271
 272 class SourceDirectoryList : public SByteStringList
 273 {
 274 public:
 275     /* create a empty directory list
 276      */
 277     SourceDirectoryList()
 278     {
 279     }
 280     ~SourceDirectoryList();
 281
 282     /* search for a directory by directory name
 283      */
 284     SourceDirectory *Search(
 285         const ByteString &rDirectoryName        // name without parent
 286     );
 287
 288     /* insert a new directory
 289      */
 290     ULONG InsertSorted(
 291         SourceDirectory *pDirectory     // directory
 292     )
 293     {
 294         return PutString(( ByteString * ) pDirectory );
 295     }
 296 };
 297
 298 #endif