0028838: Configuration - undefine macros coming from X11 headers in place of collision
[occt.git] / src / OSD / OSD_Process.hxx
1 // Created on: 2018-03-15
2 // Created by: Stephan GARNAUD (ARM)
3 // Copyright (c) 1998-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _OSD_Process_HeaderFile
18 #define _OSD_Process_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <OSD_Error.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Integer.hxx>
27 class OSD_OSDError;
28 class TCollection_AsciiString;
29 class Quantity_Date;
30 class OSD_Path;
31
32 // undefine SetCurrentDirectory that can be #defined by previous inclusion of windows.h
33 #ifdef SetCurrentDirectory
34 # undef SetCurrentDirectory
35 #endif
36
37 //! A set of system process tools
38 class OSD_Process 
39 {
40 public:
41
42   DEFINE_STANDARD_ALLOC
43
44   
45   //! Initializes the object and prepare for a possible dump
46   Standard_EXPORT OSD_Process();
47   
48   //! Issues a shell command
49   //! ShowWindow : flag to allow show/hide of the window ( only used on WNT )
50   Standard_EXPORT Standard_Integer Spawn (const TCollection_AsciiString& cmd, const Standard_Boolean ShowWindow = Standard_True);
51   
52   //! Returns the terminal used (vt100, vt200 ,sun-cmd ...)
53   Standard_EXPORT void TerminalType (TCollection_AsciiString& Name);
54   
55   //! Gets system date.
56   Standard_EXPORT Quantity_Date SystemDate();
57   
58   //! Returns the user name.
59   Standard_EXPORT TCollection_AsciiString UserName();
60   
61   //! Returns True if the process user is the super-user.
62   Standard_EXPORT Standard_Boolean IsSuperUser();
63   
64   //! Returns the 'Process Id'
65   Standard_EXPORT Standard_Integer ProcessId();
66   
67   //! Returns the current path where the process is.
68   Standard_EXPORT OSD_Path CurrentDirectory();
69   
70   //! Changes the current process directory.
71   Standard_EXPORT void SetCurrentDirectory (const OSD_Path& where);
72   
73   //! Returns TRUE if an error occurs
74   Standard_EXPORT Standard_Boolean Failed() const;
75   
76   //! Resets error counter to zero
77   Standard_EXPORT void Reset();
78   
79   //! Raises OSD_Error
80   Standard_EXPORT void Perror();
81   
82   //! Returns error number if 'Failed' is TRUE.
83   Standard_EXPORT Standard_Integer Error() const;
84
85
86
87
88 protected:
89
90
91
92
93
94 private:
95
96
97
98   OSD_Error myError;
99
100
101 };
102
103
104
105
106
107
108
109 #endif // _OSD_Process_HeaderFile