HelpSource/Classes/LanguageConfig.schelp

   1 CLASS:: LanguageConfig
   2 summary:: Access and modify interpreter configuration
   3 categories:: Language
   4
   5 DESCRIPTION::
   6 The LanguageConfig class provides access to the interpreter configuration.
   7
   8
   9 section:: Configuration File Format
  10 The configuration file is stored in YAML format, which contains one dictionary. The semantics of the dictionary is listed in
  11 the following table:
  12
  13 definitionList::
  14 ## teletype::includePaths:: || List of class library paths.
  15 ## teletype::excludePaths:: || List of paths to exclude from the class library files (overrides teletype::includePaths::).
  16 ## teletype::postInlineWarnings:: || Boolean flag to post warnings about missing inline opportunities.
  17 ::
  18
  19 CLASSMETHODS::
  20
  21 METHOD:: store
  22 Store the current configuration to file.
  23
  24 argument:: file
  25 Configuration file to store. If the value is code::nil:: it defaults to code::Platform.userConfigDir +/+ "sclang_conf.yaml"::
  26
  27 subsection:: Library Path Handling
  28
  29 The language configuration mechanism provides a way to add or exclude specific paths for the class library.
  30
  31 note::Changes to the class library paths won't have any effect before recompiling the class library.::
  32
  33 METHOD:: includePaths
  34 Return the class library include paths.
  35
  36 METHOD:: addIncludePath
  37 Add new class library include path.
  38
  39 METHOD:: removeIncludePath
  40 Remove path from class library include paths.
  41
  42 METHOD:: excludePaths
  43 Return the class library exclude paths.
  44
  45 METHOD:: addExcludePath
  46 Add new class library exclude path.
  47
  48 METHOD:: removeExcludePath
  49 Remove path from class library exclude paths.
  50
  51 subsection:: Compiler Warnings
  52
  53 METHOD:: postInlineWarnings
  54 Get or set the compiler flag, whether warnings should be posted if a FunctionDef cannot be inlined.