/* Copyright (C) 2007-2011, Gabriel Dos Reis. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - Neither the name of The Numerical Algorithms Group Ltd. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef OPENAXIOM_included #define OPENAXIOM_included #include #include "openaxiom-c-macros.h" /* Annotation to request C calling convention */ #ifdef __cplusplus # define OPENAXIOM_C_CALL extern "C" #else # define OPENAXIOM_C_CALL #endif /* Cope with MS-platform oddities. */ #ifdef __WIN32__ # ifdef DLL_EXPORT # define OPENAXIOM_EXPORT __declspec(dllexport) # elif defined(OPENAXIOM_DLL_IMPORT) # define OPENAXIOM_EXPORT __declspec(dllimport) # endif /* DLL_EXPORT */ # ifndef WIN32_LEAN_AND_MEAN # define WIN32_LEAN_AND_MEAN # endif #endif /* __WIN32__ */ #ifndef OPENAXIOM_EXPORT # define OPENAXIOM_EXPORT /* nothing */ #endif /* OPENAXIOM_EXPORT */ #define OPENAXIOM_C_EXPORT OPENAXIOM_C_CALL OPENAXIOM_EXPORT #if defined(HAVE_STDINT_H) # include #elif defined (HAVE_INTTYPES_H) # include #endif #if defined(__WIN32__) # include #endif #if defined(HAVE_UNISTD_H) # include #endif /* Do we have graphics support? */ #ifdef X_DISPLAY_MISSING # define OPENAXIOM_HAVE_GRAPHICS 0 #else # define OPENAXIOM_HAVE_GRAPHICS 1 #endif namespace OpenAxiom { // A name for the byte datatype. typedef uint8_t Byte; // An opaque datatype #ifdef __WIN32__ typedef HANDLE Handle; #else typedef void* Handle; #endif // Byte order of machine word data. enum Byteorder { unknown_endian, little_endian, big_endian }; // Datatype for packaging information necessary tolaunch a process. struct Process { int argc; char** argv; int id; }; enum SpawnFlags { spawn_search_path = 0x01, spawn_replace = 0x02, }; // Return the address of the byte array object representation of `t'. template inline Byte* byte_address(T& t) { return reinterpret_cast(&t); } /* Internal field separator character. */ #if defined(__WIN32__) # define openaxiom_ifs ';' #else # define openaxiom_ifs ':' #endif /* Paths to LaTeX input support file directories. These paths are relative to system directory. */ #define OPENAXIOM_TEXINPUTS_PATH "/share/texmf/tex" #define OPENAXIOM_BIBINPUTS_PATH "/share/texmf/tex" /* The function sleep() is not available under Windows. Instead, they have Sleep(); with capital S, please. Furthermore, it does not take argument in second, but in milliseconds, three order of magnitude of difference when compared to the Unix world. We abstract over that difference here. */ static inline void openaxiom_sleep(int n) { #if defined(__WIN32__) Sleep(n * 1000); #else sleep(n); #endif } OPENAXIOM_C_EXPORT void oa_allocate_process_argv(Process*, int); OPENAXIOM_C_EXPORT int oa_spawn(Process*, SpawnFlags); OPENAXIOM_C_EXPORT const char* oa_concatenate_string(const char*, const char*); // ------------ // -- Driver -- // ------------ // A list of drivers for OpenAxiom. enum Driver { unknown_driver, // unknown driver null_driver, // do nothing config_driver, // print out configuration information sman_driver, // start Superman as master process gui_driver, // start the GUI interface core_driver, // start the core system as master process script_driver, // start the core system in script mode. compiler_driver, // start the core system in compiler mode. execute_driver, // Execute a command. translator_driver, // Start the core system in translator mode. linker_driver // start the core system in linking mode. }; // ------------- // -- Runtime -- // ------------- // A list of runtime support systems for OpenAxiom. enum Runtime { unknown_runtime, gcl_runtime, // GCL-based runtime sbcl_runtime, // SBCL-based runtime clisp_runtime, // CLISP-based runtime ecl_runtime, // ECL-based runtime clozure_runtime, // Clozure CL-based runtime bemol_runtime, // Bemol-based runtime polyml_runtome // Poly/ML abstract machine-based runtime }; // --------------- // -- Arguments -- // --------------- // Command line arguments. // When non empty, this vector really is of length one more than // what size() reports, as it is always null-terminated, to comply // with POSIX-style operating system requirements. struct Arguments : std::vector { explicit Arguments(int n = 0); int size() const; void allocate(int); char* const* data() const; }; // ------------- // -- Command -- // ------------- // A description of external command to be executed. struct Command { Process core; // arguments for actual executable. Arguments rt_args; // arguments to the base RT, if any. const char* root_dir; // path to the OpenAxiom system. const char* exec_path; // path to the program to execute. Command(); }; const char* get_systemdir(int argc, char*[]); const char* make_path_for(const char*, Driver); // Return a pointer the string value associated with an option. const char* option_value(const Command*, const char*); int execute_core(const Command*, Driver); void build_rts_options(Command*, Driver); Driver preprocess_arguments(Command*, int, char**); // Return the length of an array literal. template inline int length(T(&)[N]) { return N; } } #endif /* OPENAXIOM_included */ // Local Variables: // mode: c++ // End: