Console

Console message logging. More...

Collaboration diagram for Console:

Files
file	console.scad
	Message logging functions.

Functions
module	log_echo (m)
	Output message to console. More...
module	log_debug (m)
	Output diagnostic message to console. More...
module	log_info (m)
	Output information message to console. More...
module	log_warn (m)
	Output warning message to console. More...
module	log_error (m)
	Output error message to console. More...

Detailed Description

Console message logging.

Example

    use <console.scad>;

    $log_debug = true;
    message = "console log message";

    // general
    log_echo( message );

    // debugging
    log_debug( message );
    log_debug( message, $log_debug = false );

    // information
    log_info( message );

    // warning
    log_warn( message );

    // error
    log_error( message );

Result

ECHO: "console log message"
ECHO: "[ DEBUG ] root(); console log message"
ECHO: "[ INFO ] root(); console log message"
ECHO: 
ECHO: "root()"
ECHO: "###################################"
ECHO: "# [ WARNING ] console log message #"
ECHO: "###################################"
ECHO: 
ECHO: "root()"
ECHO: "###################################"
ECHO: "###################################"
ECHO: "##                               ##"
ECHO: "## [ ERROR ] console log message ##"
ECHO: "##                               ##"
ECHO: "###################################"
ECHO: "###################################"

Function Documentation

module log_debug

(

m

)

Output diagnostic message to console.

Parameters

m	<string> An output message.

When $log_debug == true, message is written to the console. When false, output is not generated.

Definition at line 77 of file console.scad.

module log_echo

(

m

)

Output message to console.

Parameters

m	<string> An output message.

Definition at line 61 of file console.scad.

module log_error

(

m

)

Output error message to console.

Parameters

m	<string> An output message.

Output an error message to the console. Ideally, rendering should halt and the script should exit. However, no suitable abort function exists. To alert of the critical error, the error message is also rendered graphically.

Definition at line 138 of file console.scad.

module log_info

(

m

)

Output information message to console.

Parameters

m	<string> An output message.

Definition at line 94 of file console.scad.

module log_warn

(

m

)

Output warning message to console.

Parameters

m	<string> An output message.

Definition at line 109 of file console.scad.