xref: /trunk/main/tools/inc/bootstrp/mkcreate.hxx (revision 7ddf03623edf826092ce61060f7c0ce4b001bba2)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef _MK_CREATE_HXX
#define _MK_CREATE_HXX

#include <tools/string.hxx>
//#include "bootstrp/sstring.hxx"

DECLARE_LIST( UniStringList, UniString* )

#include <tools/list.hxx>
#include "bootstrp/prj.hxx"

class SvStream;
class SourceDirectoryList;

//
// class SourceDirectoryDependency
//

class CodedDependency : public ByteString
{
private:
    sal_uInt16 nOSType;                         // operating systems where dependency exists

public:
    /* create a dependency instance with given coded directory name
     */
    CodedDependency(
        const ByteString &rCodedIdentifier, // the coded name of the directory
        sal_uInt16 nOperatingSystems            // the operating systems where this dependency exists
    ) :
    ByteString( rCodedIdentifier ),
    nOSType( nOperatingSystems )
    {
    }

    /* returns the operating system
     */
    sal_uInt16 GetOperatingSystem()
    {
        return nOSType;
    }

    /* set operating system
     */
    void SetOperatingSystem( sal_uInt16 nOperatingSystems )
    {
        nOSType = nOperatingSystems;
    }

    /* add operating systems if same dependency
     */
    sal_Bool TryToMerge(
        const ByteString &rCodedIdentifier, // the coded name of the directory
        sal_uInt16 nOperatingSystems            // the operating systems where this dependency exists
    )
    {
        if ( rCodedIdentifier != *this )
            return sal_False;
        nOSType |= nOperatingSystems;
        return sal_True;
    }
};

//
// class Dependency
//

class Dependency : public ByteString
{
private:
    sal_uInt16 nOSType;                         // operating systems where dependency exists

public:
    /* create a dependency instance with given directory name
     */
    Dependency(
        const ByteString &rDirectoryName,   // the coded name of the directory
        sal_uInt16 nOperatingSystems            // the operating systems where this dependency exists
    ) :
    ByteString( rDirectoryName ),
    nOSType( nOperatingSystems )
    {
    }

    /* returns the operating system
     */
    sal_uInt16 GetOperatingSystem()
    {
        return nOSType;
    }
};

//
// class SourceDirectory
//

class SourceDirectory : public ByteString
{
private:
    SourceDirectory *pParent;               // the parent directory
    SourceDirectoryList *pSubDirectories;   // list of sub directories
    sal_uInt16 nOSType;                         // operating systems where this directory is used
    sal_uInt16 nDepth;                          // depth of directory structure (root is 0)

    SByteStringList *pDependencies;         // dependencies on other directories in this depth

    SByteStringList *pCodedDependencies;    // dependencies on other directories in different depth
    SByteStringList *pCodedIdentifier;      // symbolic identifier to resolve dependencies

    /* try to resolve a single dependency
     */
    Dependency *ResolvesDependency(
        CodedDependency *pCodedDependency   // the dependency
    );

    /* returns the operating systems of a coded dependency
     */
    static sal_uInt16 GetOSType(
        const ByteString &sDependExt        // the corresponding dependency extension (see also prj.hxx)
    );

    /* removes this and all sub directories with all dependencies
     */
    sal_Bool RemoveDirectoryTreeAndAllDependencies();

public:

    /* create a directory instance with given parent and name, no parent means this is the root
     * (not the file system root but the root of the source tree, e.g. o:\569)
     */
    SourceDirectory(
        const ByteString &rDirectoryName,           // name without parent
        sal_uInt16 nOperatingSystem,                    // the operating systems where this directory is used
        SourceDirectory *pParentDirectory = NULL    // parent (if not root)
    );
    ~SourceDirectory();

    /* returns the full absolute path of this directory
     */
    ByteString GetFullPath();

    /* returns a list of all sub directories
     */
    SourceDirectoryList *GetSubDirectories() { return pSubDirectories; }

    /* returns the Operating systems where this directory is used
     */
    sal_uInt16 GetOperatingSystems() { return nOSType; }

    /* returns the given directory
     */
    SourceDirectory *GetDirectory(
        const ByteString &rDirectoryName,   // full path
        sal_uInt16 nOperatingSystem             // the operating systems where this directory is used
    );

    /* create the directory and all mandatory parents
     */
    SourceDirectory *InsertFull(
        const ByteString &rDirectoryName,   // full path
        sal_uInt16 nOperatingSystem             // the operating systems where this directory is used
    )
    {
        return GetDirectory( rDirectoryName, nOperatingSystem );
    }

    /* create the directory as sub directory of this directory
     */
    SourceDirectory *Insert(
        const ByteString &rDirectoryName,   // name without parent
        sal_uInt16 nOperatingSystem             // the operating systems where this directory is used
    );

    /* get the root directory
     */
    SourceDirectory *GetRootDirectory();

    /* get sub directory if exists
     */
    SourceDirectory *GetSubDirectory(
        const ByteString &rDirectoryPath,   // full sub path
        sal_uInt16 nOperatingSystem             // the operating systems where this directory is used
    );

    /* add a dependency for several platforms
     */
    CodedDependency *AddCodedDependency(
        const ByteString &rCodedIdentifier, // the coded name of the directory
        sal_uInt16 nOperatingSystems            // the operating systems where this dependency exists
    );

    /* returns the dependency list
     */
    SByteStringList *GetCodedDependencies()
    {
        return pCodedDependencies;
    }

    /* add symbolic identifier to resolve dependencies (to this directory and all parents)
     */
    CodedDependency *AddCodedIdentifier(
        const ByteString &rCodedIdentifier, // the coded name of the directory
        sal_uInt16 nOperatingSystems            // the operating systems where this dependency exists
    );

    /* returns the identifier list
     */
    SByteStringList *GetCodedIdentifier()
    {
        return pCodedIdentifier;
    }

    /* create dependencies on other directory, coded dependencies are used
     */
    void ResolveDependencies();

    /* returns the target definition for this directory (if dependencies exist)
     */
    ByteString GetTarget();

    /* returns the target definition for all sub directory
     */
    ByteString GetSubDirsTarget();

    /* create the full directory tree (only virtual, not in file system)
     */
    static SourceDirectory *CreateRootDirectory(
        const ByteString &rRoot,    // the root directory in file system
        const ByteString &rVersion, // the solar version (r.g. SRC590, SRC591 etc.)
        sal_Bool bAll = sal_False           // add all directories or only buildable ones
    );

    /* create the makefile.rc in file system
     */
    sal_Bool CreateRecursiveMakefile(
        sal_Bool bAllChilds = sal_False     // create recursive for all sub directories
    );
};

//
// class SourceDirectoryList
//

class SourceDirectoryList : public SByteStringList
{
public:
    /* create a empty directory list
     */
    SourceDirectoryList()
    {
    }
    ~SourceDirectoryList();

    /* search for a directory by directory name
     */
    SourceDirectory *Search(
        const ByteString &rDirectoryName    // name without parent
    );

    /* insert a new directory
     */
    sal_uIntPtr InsertSorted(
        SourceDirectory *pDirectory     // directory
    )
    {
        return PutString(( ByteString * ) pDirectory );
    }
};

#endif