1 /* 2 * Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 27 #ifndef SYSINFO_H 28 #define SYSINFO_H 29 30 #include "tstrings.h" 31 32 33 // 34 // This namespace provides information about environment in which 35 // the current application runs. 36 // It is for general purpose use. 37 // Functions in this namespaces are just queries about the environment. 38 // Functions that change the existing environment like file or directory 39 // creation should not be added to this namespace. 40 // 41 namespace SysInfo { 42 /** 43 * Returns temp dir (for the current user). 44 */ 45 tstring getTempDir(); 46 47 /** 48 * Returns absolute path to the process executable. 49 */ 50 tstring getProcessModulePath(); 51 52 /** 53 * Returns absolute path to the current executable module. 54 */ 55 tstring getCurrentModulePath(); 56 57 enum CommandArgProgramNameMode { 58 IncludeProgramName, 59 ExcludeProgramName 60 }; 61 /** 62 * Retrieves the command-line arguments for the current process. 63 * With IncludeProgramName option returns result similar to argv/argc. 64 * With ExcludeProgramName option program name 65 * (the 1st element of command line) 66 * is excluded. 67 */ 68 tstring_array getCommandArgs( 69 CommandArgProgramNameMode progNameMode = ExcludeProgramName); 70 71 /** 72 * Returns value of environment variable with the given name. 73 * Throws exception if variable is not set or any other error occurred 74 * reading the value. 75 */ 76 tstring getEnvVariable(const tstring& name); 77 78 /** 79 * Returns value of environment variable with the given name. 80 * Returns value of 'defValue' parameter if variable is not set or any 81 * other error occurred reading the value. 82 */ 83 tstring getEnvVariable(const std::nothrow_t&, const tstring& name, 84 const tstring& defValue=tstring()); 85 86 /** 87 * Sets the value of environment variable with the given name to the given value. 88 */ 89 void setEnvVariable(const tstring& name, const tstring& value); 90 91 /** 92 * Returns 'true' if environment variable with the given name is set. 93 */ 94 bool isEnvVariableSet(const tstring& name); 95 96 } 97 98 #endif // SYSINFO_H 99