desktop/inc/dp_misc.h

   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
  20 #ifndef INCLUDED_DESKTOP_INC_DP_MISC_H
  21 #define INCLUDED_DESKTOP_INC_DP_MISC_H
  22
  23 #include <rtl/ustrbuf.hxx>
  24 #include <rtl/instance.hxx>
  25 #include <osl/mutex.hxx>
  26 #include <osl/process.h>
  27 #include <com/sun/star/uno/XComponentContext.hpp>
  28 #include <com/sun/star/lang/XComponent.hpp>
  29 #include <com/sun/star/lang/DisposedException.hpp>
  30 #include <com/sun/star/deployment/XPackageRegistry.hpp>
  31 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  32 #include <com/sun/star/awt/XWindow.hpp>
  33 #include <dp_misc_api.hxx>
  34
  35 namespace dp_misc {
  36
  37 const sal_Char CR = 0x0d;
  38 const sal_Char LF = 0x0a;
  39
  40
  41 class MutexHolder
  42 {
  43     mutable ::osl::Mutex m_mutex;
  44 protected:
  45     ::osl::Mutex & getMutex() const { return m_mutex; }
  46 };
  47
  48
  49 inline void try_dispose( css::uno::Reference< css::uno::XInterface> const & x )
  50 {
  51     css::uno::Reference< css::lang::XComponent> xComp( x, css::uno::UNO_QUERY );
  52     if (xComp.is())
  53         xComp->dispose();
  54 }
  55
  56
  57
  58
  59 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
  60 OUString expandUnoRcTerm( OUString const & term );
  61
  62 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
  63 OUString makeRcTerm( OUString const & url );
  64
  65
  66 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
  67 OUString expandUnoRcUrl( OUString const & url );
  68
  69
  70
  71 /** appends a relative path to a url.
  72
  73     The relative path must already be correctly encoded for use in a URL.
  74     If the URL starts with vnd.sun.star.expand then the relative path will
  75     be again encoded for use in an "expand" URL.
  76  */
  77 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString makeURL(
  78     OUString const & baseURL, OUString const & relPath );
  79
  80
  81 /** appends a relative path to a url.
  82
  83     This is the same as makeURL, but the relative Path must me a segment
  84     of an system path.
  85  */
  86 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString makeURLAppendSysPathSegment(
  87     OUString const & baseURL, OUString const & relPath );
  88
  89
  90 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString generateRandomPipeId();
  91
  92 class AbortChannel;
  93
  94 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
  95 css::uno::Reference< css::uno::XInterface> resolveUnoURL(
  96     OUString const & connectString,
  97     css::uno::Reference< css::uno::XComponentContext> const & xLocalContext,
  98     AbortChannel const * abortChannel = nullptr );
  99
 100
 101 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC bool office_is_running();
 102
 103
 104 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 105 oslProcess raiseProcess( OUString const & appURL,
 106                          css::uno::Sequence< OUString > const & args );
 107
 108
 109
 110 /** writes the argument string to the console.
 111     On Linux/Unix/etc. it converts the UTF16 string to an ANSI string using
 112     osl_getThreadTextEncoding() as target encoding. On Windows it uses WriteFile
 113     with the standard out stream. unopkg.com reads the data and prints them out using
 114     WriteConsoleW.
 115 */
 116 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 117 void writeConsole(OUString const & sText);
 118
 119 /** writes the argument to the console using the error stream.
 120     Otherwise the same as writeConsole.
 121 */
 122 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 123 void writeConsoleError(OUString const & sText);
 124
 125
 126 /** reads from the console.
 127     On Linux/Unix/etc. it uses fgets to read char values and converts them to OUString
 128     using osl_getThreadTextEncoding as target encoding. The returned string has a maximum
 129     size of 1024 and does NOT include leading and trailing white space(applied OUString::trim())
 130 */
 131 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 132 OUString readConsole();
 133
 134 /** print the text to the console in a debug build.
 135     The argument is forwarded to writeConsole. The function does not add new line.
 136     The code is only executed if  OSL_DEBUG_LEVEL > 1
 137 */
 138 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 139 void TRACE(OUString const & sText);
 140
 141 /** registers or revokes shared or bundled extensions which have been
 142     recently added or removed.
 143 */
 144 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 145 void syncRepositories(
 146     bool force,
 147     css::uno::Reference<
 148         css::ucb::XCommandEnvironment> const & xCmdEnv);
 149
 150 /** workaround: for some reason the bridge threads which communicate with the
 151     uno.exe process are not released on time
 152 */
 153 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC
 154 void disposeBridges(
 155     css::uno::Reference< css::uno::XComponentContext >
 156         const & ctx);
 157
 158 }
 159
 160 #endif
 161
 162 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */