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