LibreOffice
LibreOffice 6.0 SDK C/C++ API Reference
process.h
Go to the documentation of this file.
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 
21 #ifndef INCLUDED_OSL_PROCESS_H
22 #define INCLUDED_OSL_PROCESS_H
23 
24 #include <sal/config.h>
25 
26 #include <osl/file.h>
27 #include <osl/pipe.h>
28 #include <osl/security.h>
29 #include <osl/socket.h>
30 #include <osl/time.h>
31 #include <rtl/locale.h>
32 #include <rtl/textenc.h>
33 #include <rtl/ustring.h>
34 #include <sal/saldllapi.h>
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 
41 typedef sal_Int32 oslProcessOption;
42 #define osl_Process_WAIT 0x0001 /* wait for completion */
43 #define osl_Process_SEARCHPATH 0x0002 /* search path for executable */
44 #define osl_Process_DETACHED 0x0004 /* run detached */
45 #define osl_Process_NORMAL 0x0000 /* run in normal window */
46 #define osl_Process_HIDDEN 0x0010 /* run hidden */
47 #define osl_Process_MINIMIZED 0x0020 /* run in minimized window */
48 #define osl_Process_MAXIMIZED 0x0040 /* run in maximized window */
49 #define osl_Process_FULLSCREEN 0x0080 /* run in fullscreen window */
50 
51 typedef sal_Int32 oslProcessData;
52 
53 /* defines for osl_getProcessInfo , can be OR'ed */
54 #define osl_Process_IDENTIFIER 0x0001 /* retrieves the process identifier */
55 #define osl_Process_EXITCODE 0x0002 /* retrieves exit code of the process */
56 #define osl_Process_CPUTIMES 0x0004 /* retrieves used cpu time */
57 #define osl_Process_HEAPUSAGE 0x0008 /* retrieves the used size of heap */
58 
59 typedef sal_uInt32 oslProcessIdentifier;
60 typedef sal_uInt32 oslProcessExitCode;
61 
62 typedef enum {
63  osl_Process_E_None, /* no error */
64  osl_Process_E_NotFound, /* image not found */
65  osl_Process_E_TimedOut, /* timout occurred */
66  osl_Process_E_NoPermission, /* permission denied */
67  osl_Process_E_Unknown, /* unknown error */
68  osl_Process_E_InvalidError, /* unmapped error */
71 
72 #ifdef SAL_W32
73 # pragma pack(push, 8)
74 #endif
75 
76 typedef struct {
77  sal_uInt32 Size;
78  oslProcessData Fields;
79  oslProcessIdentifier Ident;
80  oslProcessExitCode Code;
83  sal_uInt32 HeapUsage;
85 
86 #if defined( SAL_W32)
87 # pragma pack(pop)
88 #endif
89 
98 typedef void* oslProcess;
99 
153 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess(
154  rtl_uString* ustrImageName,
155  rtl_uString* ustrArguments[],
156  sal_uInt32 nArguments,
157  oslProcessOption Options,
158  oslSecurity Security,
159  rtl_uString* ustrDirectory,
160  rtl_uString* ustrEnvironments[],
161  sal_uInt32 nEnvironmentVars,
162  oslProcess* pProcess);
163 
164 
232 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_executeProcess_WithRedirectedIO(
233  rtl_uString* strImageName,
234  rtl_uString* ustrArguments[],
235  sal_uInt32 nArguments,
236  oslProcessOption Options,
237  oslSecurity Security,
238  rtl_uString* ustrDirectory,
239  rtl_uString* ustrEnvironments[],
240  sal_uInt32 nEnvironmentVars,
241  oslProcess* pProcess,
242  oslFileHandle* pChildInputWrite,
243  oslFileHandle* pChildOutputRead,
244  oslFileHandle* pChildErrorRead);
245 
254 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_terminateProcess(
255  oslProcess Process);
256 
257 
266 SAL_DLLPUBLIC oslProcess SAL_CALL osl_getProcess(
267  oslProcessIdentifier Ident) SAL_COLD;
268 
269 
275  oslProcess Process);
276 
277 
285 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcess(
286  oslProcess Process);
287 
301 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_joinProcessWithTimeout(
302  oslProcess Process, const TimeValue* pTimeout);
303 
320 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessInfo(
321  oslProcess Process, oslProcessData Fields, oslProcessInfo* pInfo);
322 
334 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getExecutableFile(
335  rtl_uString **strFile);
336 
341 SAL_DLLPUBLIC sal_uInt32 SAL_CALL osl_getCommandArgCount(void);
342 
349 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getCommandArg(
350  sal_uInt32 nArg, rtl_uString **strCommandArg);
351 
365 SAL_DLLPUBLIC void SAL_CALL osl_setCommandArgs (int argc, char **argv);
366 
371 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getEnvironment(
372  rtl_uString *strVar, rtl_uString **strValue);
373 
380 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setEnvironment(
381  rtl_uString *strVar, rtl_uString *strValue);
382 
388 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_clearEnvironment(
389  rtl_uString *strVar);
390 
397 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessWorkingDir(
398  rtl_uString **pustrWorkingDir );
399 
405 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_getProcessLocale(
406  rtl_Locale ** ppLocale );
407 
416 SAL_DLLPUBLIC oslProcessError SAL_CALL osl_setProcessLocale(
417  rtl_Locale * pLocale );
418 
419 #ifdef __cplusplus
420 }
421 #endif
422 
423 #endif // INCLUDED_OSL_PROCESS_H
424 
425 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_DLLPUBLIC sal_uInt32 osl_getCommandArgCount(void)
sal_uInt32 oslProcessIdentifier
Definition: process.h:59
sal_uInt32 HeapUsage
Definition: process.h:83
#define SAL_DLLPUBLIC
Definition: saldllapi.h:30
SAL_DLLPUBLIC oslProcessError osl_getProcessWorkingDir(rtl_uString **pustrWorkingDir)
Get the working directory of the current process as a file URL.
SAL_DLLPUBLIC void osl_freeProcessHandle(oslProcess Process)
Free the specified process-handle.
void * oslFileHandle
Definition: file.h:622
Definition: process.h:66
SAL_DLLPUBLIC oslProcessError osl_getProcessLocale(rtl_Locale **ppLocale)
Get the locale the process is currently running in.
SAL_DLLPUBLIC oslProcessError osl_joinProcess(oslProcess Process)
Wait for completion of the specified childprocess.
#define SAL_MAX_ENUM
Definition: types.h:228
sal_uInt32 oslProcessExitCode
Definition: process.h:60
Main goals and usage hints.
oslProcessError
Definition: process.h:62
SAL_DLLPUBLIC oslProcessError osl_setEnvironment(rtl_uString *strVar, rtl_uString *strValue)
Set the value of one environment variable.
oslProcessData Fields
Definition: process.h:78
void * oslProcess
Process handle.
Definition: process.h:98
SAL_DLLPUBLIC oslProcessError osl_getProcessInfo(oslProcess Process, oslProcessData Fields, oslProcessInfo *pInfo)
Retrieves information about a Process.
The implementation structure of a locale.
Definition: locale.h:42
SAL_DLLPUBLIC oslProcessError osl_getExecutableFile(rtl_uString **strFile)
Get the filename of the executable.
sal_Int32 oslProcessOption
Definition: process.h:41
SAL_DLLPUBLIC oslProcessError osl_setProcessLocale(rtl_Locale *pLocale)
Change the locale of the process.
Definition: process.h:76
SAL_DLLPUBLIC oslProcess osl_getProcess(oslProcessIdentifier Ident) SAL_COLD
SAL_DLLPUBLIC void osl_setCommandArgs(int argc, char **argv)
Set the command-line arguments as passed to the main-function of this process.
Definition: process.h:69
Definition: process.h:64
Definition: process.h:65
oslProcessExitCode Code
Definition: process.h:80
SAL_DLLPUBLIC oslProcessError osl_executeProcess_WithRedirectedIO(rtl_uString *strImageName, rtl_uString *ustrArguments[], sal_uInt32 nArguments, oslProcessOption Options, oslSecurity Security, rtl_uString *ustrDirectory, rtl_uString *ustrEnvironments[], sal_uInt32 nEnvironmentVars, oslProcess *pProcess, oslFileHandle *pChildInputWrite, oslFileHandle *pChildOutputRead, oslFileHandle *pChildErrorRead)
Execute a process and redirect child process standard IO.
SAL_DLLPUBLIC oslProcessError osl_terminateProcess(oslProcess Process)
Terminate a process.
sal_uInt32 Size
Definition: process.h:77
SAL_DLLPUBLIC oslProcessError osl_getEnvironment(rtl_uString *strVar, rtl_uString **strValue)
Get the value of one environment variable.
Definition: time.h:66
void * oslSecurity
Process handle.
Definition: security.h:45
SAL_DLLPUBLIC oslProcessError osl_executeProcess(rtl_uString *ustrImageName, rtl_uString *ustrArguments[], sal_uInt32 nArguments, oslProcessOption Options, oslSecurity Security, rtl_uString *ustrDirectory, rtl_uString *ustrEnvironments[], sal_uInt32 nEnvironmentVars, oslProcess *pProcess)
Execute a process.
TimeValue UserTime
Definition: process.h:81
oslProcessIdentifier Ident
Definition: process.h:79
sal_Int32 oslProcessData
Definition: process.h:51
SAL_DLLPUBLIC oslProcessError osl_clearEnvironment(rtl_uString *strVar)
Unsets the value of one environment variable.
SAL_DLLPUBLIC oslProcessError osl_joinProcessWithTimeout(oslProcess Process, const TimeValue *pTimeout)
Wait with a timeout for the completion of the specified child process.
Definition: process.h:67
Definition: process.h:63
TimeValue SystemTime
Definition: process.h:82
Definition: process.h:68
SAL_DLLPUBLIC oslProcessError osl_getCommandArg(sal_uInt32 nArg, rtl_uString **strCommandArg)
Get the nArg-th command-line argument passed to the main-function of this process.