mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-27 18:50:47 +00:00
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@29663 72102866-910b-0410-8b05-ffd578937521
254 lines
8.6 KiB
Objective-C
254 lines
8.6 KiB
Objective-C
/* Interface for NSProcessInfo for GNUStep
|
|
Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
|
|
|
|
Written by: Georg Tuparev, EMBL & Academia Naturalis,
|
|
Heidelberg, Germany
|
|
Tuparev@EMBL-Heidelberg.de
|
|
Last update: 08-aug-1995
|
|
|
|
This file is part of the GNUstep Base Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free
|
|
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02111 USA.
|
|
*/
|
|
|
|
#ifndef __NSProcessInfo_h_GNUSTEP_BASE_INCLUDE
|
|
#define __NSProcessInfo_h_GNUSTEP_BASE_INCLUDE
|
|
#import <GNUstepBase/GSVersionMacros.h>
|
|
|
|
#import <Foundation/NSObject.h>
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
@class NSArray;
|
|
@class NSMutableArray;
|
|
@class NSDictionary;
|
|
@class NSData;
|
|
@class NSMutableSet;
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX,GS_API_LATEST)
|
|
|
|
/**
|
|
* Constants returned by the -operatingSystem method.
|
|
* NB. The presence of a constant in this list does *NOT* imply that
|
|
* the named operating system is supported. Some values are provided
|
|
* for MacOS-X compatibility or are obsolete and provided for
|
|
* backward compatibility.
|
|
*/
|
|
enum {
|
|
NSWindowsNTOperatingSystem = 1,
|
|
NSWindows95OperatingSystem,
|
|
NSSolarisOperatingSystem,
|
|
NSHPUXOperatingSystem,
|
|
NSMACHOperatingSystem,
|
|
NSSunOSOperatingSystem,
|
|
NSOSF1OperatingSystem,
|
|
#if OS_API_VERSION(GS_API_NONE,GS_API_NONE)
|
|
GSGNULinuxOperatingSystem = 100,
|
|
GSBSDOperatingSystem,
|
|
GSBeOperatingSystem,
|
|
GSCygwinOperatingSystem
|
|
|
|
#if GS_API_VERSION(0,011500)
|
|
// Defines of deprecated constants for backward compatibility
|
|
#define NSGNULinuxOperatingSystem GSGNULinuxOperatingSystem
|
|
#define NSBSDOperatingSystem GSBSDOperatingSystem
|
|
#define NSBeOperatingSystem GSBeOperatingSystem
|
|
#define NSCygwinOperatingSystem GSCygwinOperatingSystem
|
|
#endif /* GS_API_VERSION(0,011500) */
|
|
|
|
#endif /* OS_API_VERSION(GS_API_NONE,GS_API_NONE) */
|
|
};
|
|
#endif /* OS_API_VERSION(GS_API_MACOSX,GS_API_LATEST) */
|
|
|
|
|
|
@interface NSProcessInfo: NSObject
|
|
|
|
/**
|
|
* Returns the shared NSProcessInfo object for the current process.
|
|
*/
|
|
+ (NSProcessInfo*) processInfo;
|
|
|
|
/**
|
|
* Returns an array containing the arguments supplied to start this
|
|
* process.<br />
|
|
* NB. In GNUstep, any arguments of the form --GNU-Debug=...
|
|
* are <em>not</em> included in this array ... they are part of the
|
|
* debug mechanism, and are hidden so that setting debug variables
|
|
* will not effect the normal operation of the program.<br />
|
|
* Please note, the special <code>--GNU-Debug=...</code> syntax differs from
|
|
* that which is used to specify values for the [NSUserDefaults] system.<br />
|
|
* User defaults are set on the command line by specifying the default name
|
|
* (with a leading hyphen) as one argument, and the default value as the
|
|
* following argument. The arguments used to set user defaults are
|
|
* present in the array returned by this method.
|
|
*/
|
|
- (NSArray*) arguments;
|
|
|
|
/**
|
|
* Returns a dictionary giving the environment variables which were
|
|
* provided for the process to use.
|
|
*/
|
|
- (NSDictionary*) environment;
|
|
|
|
/**
|
|
* Returns a string which may be used as a globally unique identifier.<br />
|
|
* The string contains the host name, the process ID, a timestamp and a
|
|
* counter.<br />
|
|
* The first three values identify the process in which the string is
|
|
* generated, while the fourth ensures that multiple strings generated
|
|
* within the same process are unique.
|
|
*/
|
|
- (NSString*) globallyUniqueString;
|
|
|
|
/**
|
|
* Returns the name of the machine on which this process is running.
|
|
*/
|
|
- (NSString*) hostName;
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX,GS_API_LATEST)
|
|
|
|
/**
|
|
* Return a number representing the operating system type.<br />
|
|
* The known types are listed in the header file, but not all of the
|
|
* listed types are actually implemented ... some are present for
|
|
* MacOS-X compatibility only.<br />
|
|
* <list>
|
|
* <item>NSWindowsNTOperatingSystem - used for Windows NT, and later</item>
|
|
* <item>NSWindows95OperatingSystem - probably never to be implemented</item>
|
|
* <item>NSSolarisOperatingSystem - used for Sun Solaris</item>
|
|
* <item>NSHPUXOperatingSystem - used for HP/UX</item>
|
|
* <item>NSMACHOperatingSystem - MacOSX and perhaps Hurd in future?</item>
|
|
* <item>NSSunOSOperatingSystem - Used for Sun Sun/OS</item>
|
|
* <item>NSOSF1OperatingSystem - Used for OSF/1 (probably obsolete)</item>
|
|
* <item>GSGNULinuxOperatingSystem - the GNUstep 'standard'</item>
|
|
* <item>GSBSDOperatingSystem - BSD derived operating systems</item>
|
|
* <item>GSBeperatingSystem - Used for Be-OS (probably obsolete)</item>
|
|
* <item>GSCygwinOperatingSystem - cygwin unix-like environment</item>
|
|
* </list>
|
|
*/
|
|
- (NSUInteger) operatingSystem;
|
|
|
|
/**
|
|
* Return a human readable string representing the operating system type.<br />
|
|
* The supported types are -
|
|
* <list>
|
|
* <item>NSWindowsNTOperatingSystem - used for Windows NT, and later</item>
|
|
* <item>NSWindows95OperatingSystem - probably never to be implemented</item>
|
|
* <item>NSSolarisOperatingSystem - used for Sun Solaris</item>
|
|
* <item>NSHPUXOperatingSystem - used for HP/UX</item>
|
|
* <item>NSMACHOperatingSystem - MacOSX and perhaps Hurd in future?</item>
|
|
* <item>NSSunOSOperatingSystem - Used for Sun Sun/OS</item>
|
|
* <item>NSOSF1OperatingSystem - Used for OSF/1 (probably obsolete)</item>
|
|
* <item>GSGNULinuxOperatingSystem - the GNUstep 'standard'</item>
|
|
* <item>GSBSDOperatingSystem - BSD derived operating systems</item>
|
|
* <item>GSBeperatingSystem - Used for Be-OS (probably obsolete)</item>
|
|
* <item>GSCygwinOperatingSystem - cygwin unix-like environment</item>
|
|
* </list>
|
|
*/
|
|
- (NSString*) operatingSystemName;
|
|
|
|
/**
|
|
* Returns a human readable version string for the current operating system
|
|
* version.
|
|
*/
|
|
#if OS_API_VERSION(100200,GS_API_LATEST)
|
|
- (NSString *) operatingSystemVersionString;
|
|
#endif
|
|
|
|
/**
|
|
* Returns the process identifier number which uniquely identifies
|
|
* this process on this machine.
|
|
*/
|
|
- (int) processIdentifier;
|
|
#endif
|
|
|
|
/**
|
|
* Returns the process name for this process. This may have been set using
|
|
* the -setProcessName: method, or may be the default process name (the
|
|
* file name of the binary being executed).
|
|
*/
|
|
- (NSString*) processName;
|
|
|
|
/**
|
|
* Change the name of the current process to newName.
|
|
*/
|
|
- (void) setProcessName: (NSString*)newName;
|
|
|
|
#if OS_API_VERSION(100500,GS_API_LATEST)
|
|
/** Not implemented */
|
|
- (NSUInteger) processorCount;
|
|
/** Not implemented */
|
|
- (NSUInteger) activeProcessorCount;
|
|
/** Not implemented */
|
|
- (unsigned long long) physicalMemory;
|
|
#endif
|
|
@end
|
|
|
|
#if GS_API_VERSION(GS_API_NONE,011700)
|
|
|
|
/**
|
|
* Provides GNUstep-specific methods for controlled debug logging (a GNUstep
|
|
* facility) and an internal/developer-related method.
|
|
*/
|
|
@interface NSProcessInfo (GNUstep)
|
|
|
|
/**
|
|
* Set the file to which NSLog output should be directed.<br />
|
|
* Returns YES on success, NO on failure.<br />
|
|
* By default logging goes to standard error.
|
|
*/
|
|
- (BOOL) setLogFile: (NSString*)path;
|
|
|
|
/** Obsolete ... the GSInitializeProcess() function has the same effect and
|
|
* can be called more easily from other languages (particularly C).
|
|
*/
|
|
+ (void) initializeWithArguments: (char**)argv
|
|
count: (int)argc
|
|
environment: (char**)env;
|
|
@end
|
|
|
|
/**
|
|
* Fallback/override function.<br />
|
|
* The developer must call this method to initialize
|
|
* the NSProcessInfo system if none of the system-specific hacks to
|
|
* auto-initialize it are working.<br />
|
|
* It is also safe to call this function to override the effects
|
|
* of the automatic initialisation, which some applications may need
|
|
* to do when using GNUstep libraries embedded within other frameworks.
|
|
*/
|
|
GS_EXPORT void GSInitializeProcess(int argc, char **argv, char **envp);
|
|
|
|
/**
|
|
* Function for rapid testing to see if a debug level is set.<br />
|
|
* This is used by the debugging macros.<br />
|
|
* If debug logging has been turned off, this returns NO even if
|
|
* the specified level exists in the set of debug levels.
|
|
*/
|
|
GS_EXPORT BOOL GSDebugSet(NSString *level);
|
|
|
|
#endif /* GS_API_NONE */
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#if !defined(NO_GNUSTEP) && !defined(GNUSTEP_BASE_INTERNAL)
|
|
#import <GNUstepBase/NSProcessInfo+GNUstepBase.h>
|
|
#endif
|
|
|
|
#endif /* __NSProcessInfo_h_GNUSTEP_BASE_INCLUDE */
|