org.symbian.tools.wrttools/projecttemplates/WRTKit/Utils/Logger.js
author Eugene Ostroukhov <eugeneo@symbian.org>
Fri, 05 Feb 2010 11:54:28 -0800
changeset 102 30e0796f3ebb
parent 73 c56c874eef47
child 210 0f7abfd6ae62
permissions -rw-r--r--
Warnings in new projects were fixed
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     1
/*
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     2
© Copyright 2008 Nokia Corporation. All rights reserved.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     3
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     4
IMPORTANT:  The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     5
Corporation (ÒNokiaÓ) in consideration of your agreement to the following terms. Your use, installation
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     6
and/or redistribution of the WRTKit and Example Widget files constitutes acceptance of these terms. If
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     7
you do not agree with these terms, please do not use, install, or redistribute the WRTKit and Example
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     8
Widget files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
     9
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    10
In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    11
grants you a personal, non-exclusive license, under NokiaÕs copyrights in the WRTKit and Example
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    12
Widget files, to use, reproduce, and redistribute the WRTKit and Example files, in text form (for HTML,
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    13
CSS, or JavaScript files) or binary form (for associated images), for the sole purpose of creating S60
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    14
Widgets.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    15
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    16
If you redistribute the WRTKit and Example files, you must retain this entire notice in all such
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    17
redistributions of the WRTKit and Example files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    18
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    19
You may not use the name, trademarks, service marks or logos of Nokia to endorse or promote products
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    20
that include the WRTKit and Example files without the prior written explicit agreement with Nokia.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    21
Except as expressly stated in this notice, no other rights or licenses, express or implied, are granted by
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    22
Nokia herein, including but not limited to any patent rights that may be infringed by your products that
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    23
incorporate the WRTKit and Example files or by other works in which the WRTKit and Example files
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    24
may be incorporated.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    25
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    26
The WRTKit and Example files are provided on an "AS IS" basis.  NOKIA MAKES NO
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    27
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    28
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    29
PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    30
ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    31
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    32
IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    33
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    34
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    35
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    36
DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    37
OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    38
EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    39
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    40
*/
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    41
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    42
///////////////////////////////////////////////////////////////////////////////
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    43
// Logger utility class that uses the Firebug console class.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    44
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    45
// Constructor (everything is static so this is empty).
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    46
function Logger() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    47
    // Set default logger level.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    48
    this.level = this.LOG_LEVEL_OFF;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    49
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    50
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    51
// Logger levels.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    52
Logger.prototype.LOG_LEVEL_DEBUG = 0;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    53
Logger.prototype.LOG_LEVEL_INFO = 1;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    54
Logger.prototype.LOG_LEVEL_WARN = 2;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    55
Logger.prototype.LOG_LEVEL_ERROR = 3;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    56
Logger.prototype.LOG_LEVEL_OFF = 4;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    57
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    58
Logger.prototype.level = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    59
Logger.prototype.filter = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    60
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    61
// Disable logging on other browsers except Firefox.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    62
Logger.prototype.enabled = (navigator.userAgent.indexOf("Firefox") != -1);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    63
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    64
// Dumps an objects properties and methods to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    65
Logger.prototype.dump = function(obj) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    66
    if (this.enabled) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    67
        console.dir(obj);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    68
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    69
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    70
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    71
// Dumps a stracktrace to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    72
Logger.prototype.trace = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    73
    if (this.enabled) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    74
        console.trace();
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    75
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    76
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    77
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    78
// Prints a debug message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    79
Logger.prototype.debug = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    80
    if (this.enabled && this.level <= this.LOG_LEVEL_DEBUG) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    81
        if (this.filter == null) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    82
            console.debug(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    83
        } else {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    84
            var show = false;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    85
            for (i in this.filter) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    86
                if (str.indexOf(this.filter[i]) >= 0) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    87
                    show = true;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    88
                    break;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    89
                }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    90
            }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    91
            if (show) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    92
                console.debug(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    93
            }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    94
        }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    95
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    96
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    97
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    98
// Prints an info message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    99
Logger.prototype.info = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   100
    if (this.enabled && this.level <= this.LOG_LEVEL_INFO) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   101
        console.info(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   102
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   103
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   104
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   105
// Prints a warning message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   106
Logger.prototype.warn = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   107
    if (this.enabled && this.level <= this.LOG_LEVEL_WARN) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   108
        console.warn(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   109
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   110
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   111
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   112
// Prints an error message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   113
Logger.prototype.error = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   114
    if (this.enabled && this.level <= this.LOG_LEVEL_ERROR) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   115
        console.error(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   116
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   117
};