jvmfwk/inc/fwkutil.hxx

   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 #ifndef INCLUDED_JVMFWK_SOURCE_FWKUTIL_HXX
  20 #define INCLUDED_JVMFWK_SOURCE_FWKUTIL_HXX
  21
  22 #include <config_folders.h>
  23
  24 #include <sal/config.h>
  25 #include <sal/log.hxx>
  26 #include <rtl/bootstrap.hxx>
  27 #include <rtl/byteseq.hxx>
  28 #include <osl/mutex.hxx>
  29
  30 namespace osl { class Mutex; }
  31
  32 namespace jfw
  33 {
  34
  35 /** Returns the file URL of the directory where the framework library
  36     (this library) resides.
  37 */
  38 OUString getLibraryLocation();
  39
  40 /** provides a bootstrap class which already knows the values from the
  41     jvmfkwrc file.
  42 */
  43 const rtl::Bootstrap * Bootstrap();
  44
  45 osl::Mutex& FwkMutex();
  46
  47 rtl::ByteSequence encodeBase16(const rtl::ByteSequence& rawData);
  48 rtl::ByteSequence decodeBase16(const rtl::ByteSequence& data);
  49
  50 OUString getDirFromFile(const OUString& usFilePath);
  51
  52 enum FileStatus
  53 {
  54     FILE_OK,
  55     FILE_DOES_NOT_EXIST,
  56     FILE_INVALID
  57 };
  58
  59 /** checks if the URL is a file.
  60
  61     If it is a link to a file than
  62     it is resolved. Assuming that the argument
  63     represents a relative URL then FILE_INVALID
  64     is returned.
  65
  66
  67     @return
  68     one of the values of FileStatus.
  69
  70     @exception
  71     Errors occurred during determining if the file exists
  72  */
  73 FileStatus checkFileURL(const OUString & path);
  74
  75 }
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */