Documentation for Jinni File: loqProps.pro

Use the following for the later-to-come feature of automated gui-based changing of the this loq properties by writing this very same file which is modified according to the settings the user has provided thru a GUI. Generate the file with the following statements:

?-tell(example.txt),write(example(one)),write(.),nl,told.

then you only need to renew it as usual.

Authored by:

• Wolfgang Chico Toepfer

• exceptionList/1
• fileOut/1
• level/2
• loqActivity/1
• loqProps/0
• possibleLoqActivities/1

• exceptionList/1
  
  Forms:
  • exceptionList(-DefaultExceptionList)
    
  
  determines which default exception list should be active; [none] is the minimum
  
  

  ---

• fileOut/1
  
  Forms:
  • fileOut(+FileOut)
    
  
  Indicates the path of the file Loq4Jinni is supposed to write to. When it is set to none, which is the default, the output is streamed to the console window.
  
  

  ---

• level/2
  
  Forms:
  • level(DefaultLevel, ?LevelValue)
    
  
  determines whether or not the logger will be active for the rsp. perspective (incl. hierarchical log level 0..3); a perspective with level L includes all levels below it. The current levels are known:
  • none: expresses sth. that provides no information
  • sys: expresses sth. that is low-level information
  • info: expresses sth. that provides information
  • warn: expresses sth. that perhaps needs to be printed
  • error: expresses sth. that needs to be printed
  One can add further levels to accomodate more refined level distinction depending on ones current rsp. requirements. In any case the level values need to be kept consistent.
  
  

  ---

• loqActivity/1
  
  Forms:
  • loqActivity(?DefaultLevel)
    
  
  determines which default activity level should be active either none,info, warning or error; none switches the logger off
  
  

  ---

• loqProps/0
  
  each time one modifies the values of the properties kept in this module, a call of renew(loqProps,_) is required to date up the module instance within the current Jinni session, which is all one needs to do. See the documentation of loq, Loq4Jinnis main module, for further details. NOTE: try for the next version the following idea. Because loqProps is a module we can set the loqActivity and the exceptionList by using class variables. Fully analogously with key.pro, we can then initialize the module by using :-initialization(renew(loqProps(LoqActivity,ExceptionList),_)) or by calling new(loqProps(LoqActivity,ExceptionList),_) once at JEdits startup time where LoqActivity and ExceptionList are concrete instances. The advantage is we could then provide a JinniConsole menu where you can select the loqActivity/exceptionList because we could simply call renew(loqProps(LoqActivity,ExceptionList),_) without needing to set the concrete instances in the loqProps file.
  
  

  ---

• possibleLoqActivities/1
  
  Forms:
  • possibleLoqActivities(-DefaultLevelList)
    
  
  Serves to get a list of currently allowed default levels in order to check if a correct activity level has been entered. Date up when level/2 is modified.
  
  

  ---