jvmfwk/source/fwkutil.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: fwkutil.hxx,v $
  10  * $Revision: 1.17 $
  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 #if !defined INCLUDED_JVMFWK_FWKUTIL_HXX
  31 #define INCLUDED_JVMFWK_FWKUTIL_HXX
  32
  33 #include "sal/config.h"
  34 #include "osl/mutex.hxx"
  35 #include "rtl/bootstrap.hxx"
  36 #include "rtl/instance.hxx"
  37 #include "rtl/ustrbuf.hxx"
  38 #include "rtl/byteseq.hxx"
  39 #include "osl/thread.hxx"
  40 #if OSL_DEBUG_LEVEL >=2
  41 #include <stdio.h>
  42 #endif
  43
  44
  45 namespace jfw
  46 {
  47
  48 /** Returns the file URL of the directory where the framework library
  49     (this library) resides.
  50 */
  51 rtl::OUString getLibraryLocation();
  52
  53 /** provides a bootstrap class which already knows the values from the
  54     jvmfkwrc file.
  55 */
  56 struct Bootstrap :
  57     public ::rtl::StaticWithInit< const rtl::Bootstrap *, Bootstrap > {
  58         const rtl::Bootstrap * operator () () {
  59             ::rtl::OUStringBuffer buf(256);
  60             buf.append(getLibraryLocation());
  61             buf.appendAscii(SAL_CONFIGFILE("/jvmfwk3"));
  62             ::rtl::OUString sIni = buf.makeStringAndClear();
  63             ::rtl::Bootstrap *  bootstrap = new ::rtl::Bootstrap(sIni);
  64 #if OSL_DEBUG_LEVEL >=2
  65         rtl::OString o = rtl::OUStringToOString( sIni , osl_getThreadTextEncoding() );
  66         fprintf(stderr, "[Java framework] Using configuration file %s\n" , o.getStr() );
  67 #endif
  68         return bootstrap;
  69     }
  70 };
  71
  72 struct FwkMutex: public ::rtl::Static<osl::Mutex, FwkMutex> {};
  73
  74 //osl::Mutex * getFwkMutex();
  75
  76 rtl::ByteSequence encodeBase16(const rtl::ByteSequence& rawData);
  77 rtl::ByteSequence decodeBase16(const rtl::ByteSequence& data);
  78
  79 rtl::OUString getPlatform();
  80
  81 //const rtl::Bootstrap& getBootstrap();
  82
  83
  84 rtl::OUString getDirFromFile(const rtl::OUString& usFilePath);
  85
  86 /** Returns the file URL of the folder where the executable resides.
  87  */
  88 rtl::OUString getExecutableDirectory();
  89 /** Locates the plugin library and returns the file URL.
  90
  91     First tries to locate plugin relative to baseUrl (if relative);
  92     vnd.sun.star.expand URLs are supported.  If that fails, tries to
  93     locate plugin relative to the executable.  If that fails, and plugin
  94     contains no slashes, tries to locate plugin in a platform-specific way
  95     (e.g., LD_LIBRARY_PATH).
  96
  97     @param baseUrl
  98     The base file URL relative to which the plugin argument is interpreted.
  99
 100     @param plugin
 101     The argument is an absolute or relative URL or just the name of the plugin.
 102  */
 103 rtl::OUString findPlugin(
 104     const rtl::OUString & baseUrl, const rtl::OUString & plugin);
 105
 106
 107 enum FileStatus
 108 {
 109     FILE_OK,
 110     FILE_DOES_NOT_EXIST,
 111     FILE_INVALID
 112 };
 113
 114 /** checks if the URL is a file.
 115
 116     If it is a link to a file than
 117     it is resolved. Assuming that the argument
 118     represents a relative URL then FILE_INVALID
 119     is returned.
 120
 121
 122     @return
 123     one of the values of FileStatus.
 124
 125     @exception
 126     Errors occured during determining if the file exists
 127  */
 128 FileStatus checkFileURL(const rtl::OUString & path);
 129
 130
 131 struct PluginLibrary;
 132 class VersionInfo;
 133 class CJavaInfo;
 134
 135 bool isAccessibilitySupportDesired();
 136
 137 rtl::OUString buildClassPathFromDirectory(const rtl::OUString & relPath);
 138
 139 rtl::OUString retrieveClassPath( ::rtl::OUString const & macro );
 140 }
 141 #endif