tup.config

# This file contains various settings that the user might want to adjust before building ROSE. All non-comment lines
# start with "CONFIG_" and are accessed in other tup files (like Tupfile) as either $(CONFIG_foo) or @foo.
#
# Note that parsing of this file is quite strict. In particular, there should be no extraneous white space unless it is
# intended to be part of the value.  This includes white space around the '=' and at the ends of lines!
#
# This file is the input for certain configuration steps which generate a tup.config file in the build directory. The
# values you supply here are only defaults.

########################################################################################################################
# Paths
########################################################################################################################

# Path where ROSE is ultimately installed. The "bin", "include", "lib", etc.  directories are created under the
# directory specified here.
CONFIG_INSTALLATION_PREFIX=/usr/local/rose

########################################################################################################################
# Compilers
########################################################################################################################

# Command for running the C++ compiler.
#   CXX               -- C++ compiler executable
#   CXX_O_SWITCH      -- the switch to specify the output name, as in GCC's "-o" switch.
#   CXX_C_SWITCH      -- the switch to specify that the input should be compiled but not linked, as in GCC's "-c"
#   CXX_LIBDIR_SWITCH -- switch to add a library directory, as in GCC's "-L"
#   CXX_RPATH_SWITCH  -- switch to add a directory as an rpath, as in GCC's "-Wl,-rpath,"
#   CXX_LIB_SWITCH    -- switch to link with a particular library, as in GCC's "-l"
#
# To add a space after the switch, use four single quotes with a space between them, as in '' ''. This is a kludge
# based on the fact that the shell script will treat each pair of quotes as an empty string in the command and
# prevents editors from removing white space at the ends of lines.
CONFIG_CXX=c++
CONFIG_CXX_O_SWITCH=-o'' ''
CONFIG_CXX_C_SWITCH=-c'' ''
CONFIG_CXX_LIBDIR_SWITCH=-L
CONFIG_CXX_RPATH_SWITCH=-Wl,-rpath,
CONFIG_CXX_LIB_SWITCH=-l

# Command for running the C compiler.
CONFIG_CC=cc
CONFIG_CC_O_SWITCH=-o'' ''
CONFIG_CC_C_SWITCH=-c'' ''
CONFIG_CC_INCDIR_SWITCH=-I
CONFIG_CC_LIBDIR_SWITCH=-L
CONFIG_CC_RPATH_SWITCH=-Wl,-rpath,
CONFIG_CC_LIB_SWITCH=-l

# Command for running for Fortran compiler. This is used only if ROSE is configured to support Fortran analysis.
CONFIG_FC=fc

# Whether ('yes') or not ('no') to build an LLVM-style compilation database.  If yes, then "jq" version 1.5 or later
# must be in the $PATH.
CONFIG_COMPILATION_DATABASE=no

# Whether to build static or shared libraries and executables. The value should be one of the words "shared", "static",
# or "both".
CONFIG_LINKAGE=shared

# C/C++ preprocessor and switches
#    CPPFLAGS          -- command-line switches for all invocations of the preprocessor
#    CPP_INCDIR_SWITCH -- command-line switch to add an include directory, as in GCC's "-I"
#    CPP_DEFINE_SWITCH -- command-line switch to define a variable, as in GCC's "-D"
CONFIG_CPPFLAGS=
CONFIG_CPP_INCDIR_SWITCH=-I
CONFIG_CPP_DEFINE_SWITCH=-D

# Debug switches. The "C_CXX" switches are those which are common to both the C and C++ compilers and are prefixed to
# the the compiler-specific switches.
CONFIG_C_CXX_DEBUG=
CONFIG_C_DEBUG=
CONFIG_CXX_DEBUG=

# Optimization switches. Naming is similar to the DEBUG switches above.
CONFIG_C_CXX_OPTIM=
CONFIG_C_OPTIM=
CONFIG_CXX_OPTIM=

# Warning switches that controls those constructs for which the compiler emits or suppresses warning diagnostics.
CONFIG_C_CXX_WARN=
CONFIG_C_WARN=
CONFIG_CXX_WARN=

# Additional miscellaneous switches for compiling.
CONFIG_C_CXX_MISC=
CONFIG_C_MISC=
CONFIG_CXX_MISC=

# Linker command-line switches for warnings and miscellaneous libraries.
# For linkers, try these switches:
#   -fuse-ld=ld         This is the default linker for GCC but is quite slow
#   -fuse-ld=gold       This is a faster linker developed at Google
#   -fuse-ld=lld        This is an even faster linker that's part of the LLVM work
#   -fuse-ld=mold       This is faster even than lld (see https://github.com/rui314/mold if using GCC<12)
CONFIG_LD_WARN=
CONFIG_LD_MISC=-fuse-ld=gold
CONFIG_LD_STATIC=-static
CONFIG_LD_SHARED=

# In addition to the above flags, add these additional flags during the support, librose, and tool build phases.  This
# is the appropriate place to enable things like address sanitizer (by adding -fsanitize=address to the LIBROSE and TOOL
# CXXFLAGS variables and running tools with the ASAN_OPTIONS environment variable set (e.g., ASAN_OPTIONS=detect_leaks=1).
CONFIG_SUPPORT_CPPFLAGS=
CONFIG_SUPPORT_CFLAGS=
CONFIG_SUPPORT_CXXFLAGS=
CONFIG_SUPPORT_LDFLAGS_STATIC=
CONFIG_SUPPORT_LDFLAGS_SHARED=

CONFIG_LIBROSE_CPPFLAGS=
CONFIG_LIBROSE_CFLAGS=
CONFIG_LIBROSE_CXXFLAGS=
CONFIG_LIBROSE_LDFLAGS_STATIC=
CONFIG_LIBROSE_LDFLAGS_SHARED=

CONFIG_TOOL_CPPFLAGS=
CONFIG_TOOL_CFLAGS=
CONFIG_TOOL_CXXFLAGS=
CONFIG_TOOL_LDFLAGS_STATIC=
CONFIG_TOOL_LDFLAGS_SHARED=

########################################################################################################################
# Language supoprt.
########################################################################################################################

# Set these to either "yes" or "no" depending on whether you want the ROSE library to be able to analyse (e.g., parse,
# transform, etc) that language.  Note that C is supported if and only if C++ is supported, therefore there's not a
# dedicated ENABLE_C_ANALYSIS symbol.
#
# Library developers: Within the Tupfiles, test for these features with any of the following:
#    ifeq (@(ENABLE_ADA_ANALYSIS),yes)
#    ifeq (@(ENABLE_ADA_ANALYSIS),no)
#
CONFIG_ENABLE_ADA_ANALYSIS=no
CONFIG_ENABLE_BINARY_ANALYSIS=no
CONFIG_ENABLE_COBOL_ANALYSIS=no
CONFIG_ENABLE_CUDA_ANALYSIS=no
CONFIG_ENABLE_CSHARP_ANALYSIS=no
CONFIG_ENABLE_CXX_ANALYSIS=no
CONFIG_ENABLE_FORTRAN_ANALYSIS=no
CONFIG_ENABLE_JAVA_ANALYSIS=no
CONFIG_ENABLE_JOVIAL_ANALYSIS=no
CONFIG_ENABLE_MATLAB_ANALYSIS=no
CONFIG_ENABLE_OFP_ANALYSIS=no
CONFIG_ENABLE_OPENCL_ANALYSIS=no
CONFIG_ENABLE_PHP_ANALYSIS=no
CONFIG_ENABLE_PYTHON_ANALYSIS=no

########################################################################################################################
# Features
########################################################################################################################

# Set to "yes" or "no" depending on whether you want tests to be built and run each time you build ROSE.
CONFIG_ENABLE_TESTS=yes

# Set to one of the following strings to say how ROSE logic assertions are handled by default. This behavior can be
# overridden at runtime.
#   ROSE_ASSERTION_ABORT
#   ROSE_ASSERTION_EXIT
#   ROSE_ASSERTION_THROW
CONFIG_ASSERTION_BEHAVIOR=ROSE_ASSERTION_ABORT

########################################################################################################################
# Additional software
########################################################################################################################

# These variables define whether another software package is used when building ROSE, and if so, where that software is
# installed. The following choices are allowed:
#     "no" means the softare is not to be used by ROSE.
#
#     "system" means ROSE is to use the software and should expect that it's already installed in some default location
#     on this system and will be found automatically by compilers and linkers.
#
#     A directory name means that ROSE is to use the software and that the software has been installed under the
#     specified prefix directory. The directory is the same as what you would have specified with the GNU configure
#     "--prefix=DIR" or CMake "-DCMAKE_INSTALL_PREFIX=DIR" switch when you built the software.  DO NOT use this form if
#     the software is installed in default locations (e.g., use "system" if the prefix is /usr, /usr/local, or similarly
#     well-known locations).
#
# Library developers: Within the Tupfiles, test for these features with inverted logic in order to handle having any
# prefix including the default "system" location. Example:
#    ifneq (@(WITH_WT),no)
#        #rules that depend on having WT
#    endif


# Boost is a required component, therefore "no" is not allowed.
# https://boost.org
CONFIG_WITH_BOOST=no

# Capstone disassembler
# http://www.capstone-engine.org/
CONFIG_WITH_CAPSTONE=no

# Cereal serialization
# https://uscilab.github.io/cereal/index.html
CONFIG_WITH_CEREAL=no

# Dlib is a general purpose cross-platform software library
# http://dlib.net/
CONFIG_WITH_DLIB=no

# DWARF debugging info parser library. See also CONFIG_WITH_ELF
CONFIG_WITH_DWARF=no

# ELF parsing library. ROSE has it's own built-in ELF parser, but this library is needed if CONFIG_WITH_DWARF is
# anything but "no".
CONFIG_WITH_ELF=no

# Libgcrypt is a general purpose cryptographic library
# https://www.gnupg.org/related_software/libgcrypt/
CONFIG_WITH_GCRYPT=no

# libgpg-error is needed if you set CONFIG_WITH_GCRYPT=yes
CONFIG_WITH_GPG_ERROR=no

# Intel Pin
# https://software.intel.com/en-us/articles/pin-a-dynamic-binary-instrumentation-tool
CONFIG_WITH_INTEL_PIN=no

# Magic is a library for identifying files by their "magic" numbers
CONFIG_WITH_MAGIC=no

# Postgresql C++ library
# http://pqxx.org/development/libpqxx
CONFIG_WITH_PQXX=no

# Python development library and version number (major and minor only). The X.Y version number is necessary because
# Python uses it in the include directory name and the library name.
CONFIG_WITH_PYTHON=no
CONFIG_PYTHON_VERSION=0.0

# Qt
# https://qt.io
CONFIG_WITH_QT=no

# Readline command-line editing library
CONFIG_WITH_READLINE=no

# SQLite database in a file
# https://sqlite.org/
CONFIG_WITH_SQLITE=no

# Web toolkit for developing GUIs in a web browser
CONFIG_WITH_WT=no

# YAML-CPP is a YAML parser and emitter in C++
# https://github.com/jbeder/yaml-cpp
CONFIG_WITH_YAMLCPP=no

# Z3 SMT solver
CONFIG_WITH_Z3=no

# Zlib compression library is required. Set it to something other than "system" if you've installed it in a special
# place.
CONFIG_WITH_ZLIB=system

########################################################################################################################
# Testing the ROSE library
########################################################################################################################

# Extra flags to pass to the $(ROSE)/scripts/rth_run.pl script. BTW, "RTH" stands for "ROSE Test Harness".
CONFIG_RTH_FLAGS=

# How long to allow a test to run before timing out and considering it to have failed. This should be an integer
# suffixed with "s", "m", or "h" for seconds, minutes, or hours. The value "none" means don't ever time out.
CONFIG_RTH_TIMEOUT=15m

########################################################################################################################
# Mr. ROSE level settings not intended for mere mortals. Don't change these unless you know what you're doing.
########################################################################################################################

# EDG C/C++ frontend version. See src/frontend/CxxFrontend/EDG.
CONFIG_EDG_VERSION=none

# Info about the hosting compiler (the one that compiles ROSE). Possible values for the vendor are "gnu", "llvm",
# "intel", and "microsoft". The version is the version number of the compiler, like "5.1.0". The language is the
# lower-case version of the language standard, such as "c++11", or "gnu++14", etc.
CONFIG_CXX_VENDOR=
CONFIG_CXX_VERSION=
CONFIG_CXX_LANGUAGE=

CONFIG_C_VENDOR=
CONFIG_C_VERSION=
CONFIG_C_LANGUAGE=

# Info about the target compiler (the one invoked as ROSE's backend). Values are the same possibilities as the hosting
# compiler above.
CONFIG_CXX_TARGET_VENDOR=
CONFIG_CXX_TARGET_VERSION=

# Where to get files that were generated by the GNU Autotools "configure" script, Used by scripts/tup/rose-configure-tup
# to hold state between runs.
CONFIG_AUTOTOOLS_STASH=

# Location of ROSE source tree. This gets filled in by the configuration command.
CONFIG_ROSE_SOURCE=

# Other local settings...