Helper.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
import os
 
from .Overwrite import Overwrite
 
WARNING_BANNER = """// **********************************************************************************************
// ***                                     !!!WARNING!!!                                      ***
// *** WARNING: AUTO GENERATED FILE! DO NOT MODIFY BY HAND! YOUR CHANGES WILL BE OVERWRITTEN! ***
// ***                                     !!!WARNING!!!                                      ***
// ***                  Generated by Peano's Python API: www.peano-framework.org              ***
// **********************************************************************************************
"""
 
def write_file(overwrite,overwrite_is_default,full_qualified_filename):
  """
    overwrite is of type Overwrite and is what the user passes in
    overwrite_is_default is a boolean
  """
  if overwrite==Overwrite.Always:
    return True
  elif overwrite==Overwrite.Never and os.path.exists(full_qualified_filename):
    return False
  elif overwrite==Overwrite.Never and not os.path.exists(full_qualified_filename):
    return True
  elif overwrite==Overwrite.Default:
    if not overwrite_is_default and os.path.exists(full_qualified_filename):
      return False
    else:
      return True
  else:
    print("Error: undefined overwrite strategy")
    return True
 
 
# Default for the longest class name of a generated action set. The class
# name is also the file name (plus .h or .cpp), and file names are limited to
# 255 characters on most file systems.
MAX_CLASS_NAME_LENGTH = 200
 
# Long class names handed out so far, mapped onto their shortened counterparts
_shortened_class_names = {}
 
 
def shortened_class_name(class_name, max_length=MAX_CLASS_NAME_LENGTH):
  """!
 
  Class name of a generated observer or action set which is short enough
  to serve as file name
 
  Names up to max_length characters are returned unchanged. Longer names
  are cut off and get a consecutive number appended, e.g. ..._1, ..._2.
  The cut-off names carry no meaning anymore, but every call with the same
  long name and the same max_length yields the same short name, so the
  generated files can refer to each other.
 
  @param class_name: str
    The full class name.
 
  @param max_length: int
    Longest admissible class name.
 
  """
  if len(class_name) <= max_length:
    return class_name
  key = (class_name, max_length)
  if key not in _shortened_class_names:
    suffix = "_" + str(len(_shortened_class_names) + 1)
    _shortened_class_names[key] = class_name[: max_length - len(suffix)] + suffix
  return _shortened_class_names[key]