CompileMode.py

Go to the documentation of this file.

# This file is part of the Peano project. For conditions of distribution and
# use, please see the copyright notice at www.peano-framework.org
from enum import Enum
 
class CompileMode(Enum):
  """!
  
    Compile modi
    
    The compile mode is required in my get_library() routines. It is also used
    in the Makefile template. You can use CompileModes for a list (overview) of
    all available modes. string_to_mode() finally helps you to translate a 
    string representation into an actual modus.
    
  """
  DEBUG   = 0
  TRACE   = 1
  ASSERTS = 2
  RELEASE = 3
  STATS   = 4
 
 
"""!
 
Overview over all compile modes available
 
Is often used within the argument parser:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
parser.add_argument("-m", "--mode", dest="mode", choices=peano4.api.output.CompileModes, default=peano4.api.output.CompileModes[0], help="|".join(peano4.api.output.CompileModes) )
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
"""
CompileModes = [ "RELEASE", "STATS", "TRACE", "ASSERTS", "DEBUG" ]
 
 
 
"""!
 
Convert a string into a compile mode
 
"""
def string_to_mode(mode: CompileModes):
    if mode==CompileModes[0]:
        return CompileMode.RELEASE
    if mode==CompileModes[1]:
        return CompileMode.STATS
    if mode==CompileModes[2]:
        return CompileMode.TRACE
    if mode==CompileModes[3]:
        return CompileMode.ASSERTS
    if mode==CompileModes[4]:
        return CompileMode.DEBUG
    raise Exception( "mode {} not supported".format(mode) )