bootstrap.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
 
#ifndef INCLUDED_UNOTOOLS_BOOTSTRAP_HXX
#define INCLUDED_UNOTOOLS_BOOTSTRAP_HXX
 
#include <unotools/unotoolsdllapi.h>
#include <rtl/ustring.hxx>
 
namespace utl
{
    class UNOTOOLS_DLLPUBLIC Bootstrap
    {
    // the static interface
    public: // some common information items
 
        static OUString getProductKey();
 
        static OUString getProductKey(OUString const& _sDefault);
 
        static OUString getBuildIdData(OUString const& _sDefault);
 
        static void reloadData();
 
    public: // retrieve path information about the installation location
        enum PathStatus
        {
            PATH_EXISTS,  // Success: Found a path to an existing file or directory
            PATH_VALID,   // Found a valid path, but the file or directory does not exist
            DATA_INVALID, // Retrieved a string for this path, that is not a valid file url or system path
            DATA_MISSING, // Could not retrieve any data for this path
            DATA_UNKNOWN  // No attempt to retrieve data for this path was made
        };
 
        static PathStatus locateBaseInstallation(OUString& _rURL);
 
        static PathStatus locateUserInstallation(OUString& _rURL);
 
        static PathStatus locateUserData(OUString& _rURL);
 
    // the next two items are mainly supported for diagnostic purposes. both items may be unused
        static PathStatus locateBootstrapFile(OUString& _rURL);
        static PathStatus locateVersionFile(OUString& _rURL);
 
    public: // evaluate the validity of the installation
        enum Status
        {
            DATA_OK,              
            MISSING_USER_INSTALL, 
            INVALID_USER_INSTALL, 
            INVALID_BASE_INSTALL  
        };
 
        enum FailureCode
        {
            NO_FAILURE,                   
            MISSING_INSTALL_DIRECTORY,    
            MISSING_BOOTSTRAP_FILE,       
            MISSING_BOOTSTRAP_FILE_ENTRY, 
            INVALID_BOOTSTRAP_FILE_ENTRY, 
            MISSING_VERSION_FILE,         
            MISSING_VERSION_FILE_ENTRY,   
            INVALID_VERSION_FILE_ENTRY,   
            MISSING_USER_DIRECTORY,       
            INVALID_BOOTSTRAP_DATA        
        };
 
        static Status checkBootstrapStatus(OUString& _rDiagnosticMessage, FailureCode& _rErrCode);
 
    public:
        static bool getProcessWorkingDir(OUString &rUrl);
 
    public:
        // singleton impl-class
        class UNOTOOLS_DLLPRIVATE Impl;
        static const Impl& data(); // the data related to the bootstrap.ini file
    };
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */