org.symbian.tools.wrttools/projecttemplates/WRTKit/Utils/Logger.js
author tasneems@symbian.org
Mon, 01 Mar 2010 14:14:07 -0800
changeset 210 0f7abfd6ae62
parent 102 30e0796f3ebb
child 211 7b148352159e
permissions -rw-r--r--
Fixed bug 2072: update .js files with EPL
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
210
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     1
/**
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     2
 * Copyright (c) 2009-2010 Symbian Foundation and/or its subsidiary(-ies).
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     3
 * All rights reserved.
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     4
 * This component and the accompanying materials are made available
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     5
 * under the terms of the License "Eclipse Public License v1.0"
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     6
 * which accompanies this distribution, and is available
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     8
 *
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
     9
 * Initial Contributors:
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    10
 * Symbian Foundation - initial contribution.
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    11
 * Contributors:
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    12
 */
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    13
/*
210
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    14
� Copyright 2008 Nokia Corporation. All rights reserved.
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    15
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    16
IMPORTANT:  The Nokia software ("WRTKit and Example Widget files") is supplied to you by Nokia
210
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    17
Corporation (�Nokia�) in consideration of your agreement to the following terms. Your use, installation
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    18
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
    19
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
    20
Widget files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    21
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    22
In consideration of your agreement to abide by the following terms, and subject to these terms, Nokia
210
0f7abfd6ae62 Fixed bug 2072: update .js files with EPL
tasneems@symbian.org
parents: 102
diff changeset
    23
grants you a personal, non-exclusive license, under Nokia�s copyrights in the WRTKit and Example
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    24
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
    25
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
    26
Widgets.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    27
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    28
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
    29
redistributions of the WRTKit and Example files.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    30
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    31
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
    32
that include the WRTKit and Example files without the prior written explicit agreement with Nokia.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    33
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
    34
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
    35
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
    36
may be incorporated.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    37
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    38
The WRTKit and Example files are provided on an "AS IS" basis.  NOKIA MAKES NO
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    39
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    40
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    41
PARTICULAR PURPOSE, REGARDING THE EXAMPLES OR ITS USE AND OPERATION
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    42
ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    43
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    44
IN NO EVENT SHALL NOKIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    45
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    46
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    47
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, AND/OR
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    48
DISTRIBUTION OF THE EXAMPLES, HOWEVER CAUSED AND WHETHER UNDER THEORY
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    49
OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE,
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    50
EVEN IF NOKIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    51
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    52
*/
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    53
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    54
///////////////////////////////////////////////////////////////////////////////
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    55
// Logger utility class that uses the Firebug console class.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    56
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    57
// Constructor (everything is static so this is empty).
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    58
function Logger() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    59
    // Set default logger level.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    60
    this.level = this.LOG_LEVEL_OFF;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    61
}
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    62
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    63
// Logger levels.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    64
Logger.prototype.LOG_LEVEL_DEBUG = 0;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    65
Logger.prototype.LOG_LEVEL_INFO = 1;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    66
Logger.prototype.LOG_LEVEL_WARN = 2;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    67
Logger.prototype.LOG_LEVEL_ERROR = 3;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    68
Logger.prototype.LOG_LEVEL_OFF = 4;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    69
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    70
Logger.prototype.level = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    71
Logger.prototype.filter = null;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    72
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    73
// Disable logging on other browsers except Firefox.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    74
Logger.prototype.enabled = (navigator.userAgent.indexOf("Firefox") != -1);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    75
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    76
// Dumps an objects properties and methods to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    77
Logger.prototype.dump = function(obj) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    78
    if (this.enabled) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    79
        console.dir(obj);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    80
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    81
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    82
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    83
// Dumps a stracktrace to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    84
Logger.prototype.trace = function() {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    85
    if (this.enabled) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    86
        console.trace();
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    87
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
    88
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    89
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    90
// Prints a debug message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    91
Logger.prototype.debug = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    92
    if (this.enabled && this.level <= this.LOG_LEVEL_DEBUG) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    93
        if (this.filter == null) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    94
            console.debug(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    95
        } else {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    96
            var show = false;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    97
            for (i in this.filter) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    98
                if (str.indexOf(this.filter[i]) >= 0) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
    99
                    show = true;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   100
                    break;
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   101
                }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   102
            }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   103
            if (show) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   104
                console.debug(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   105
            }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   106
        }
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   107
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   108
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   109
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   110
// Prints an info message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   111
Logger.prototype.info = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   112
    if (this.enabled && this.level <= this.LOG_LEVEL_INFO) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   113
        console.info(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   114
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   115
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   116
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   117
// Prints a warning message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   118
Logger.prototype.warn = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   119
    if (this.enabled && this.level <= this.LOG_LEVEL_WARN) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   120
        console.warn(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   121
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   122
};
73
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   123
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   124
// Prints an error message to the console.
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   125
Logger.prototype.error = function(str) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   126
    if (this.enabled && this.level <= this.LOG_LEVEL_ERROR) {
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   127
        console.error(str);
c56c874eef47 Added WRTKit
tasneems@symbian.org
parents:
diff changeset
   128
    }
102
30e0796f3ebb Warnings in new projects were fixed
Eugene Ostroukhov <eugeneo@symbian.org>
parents: 73
diff changeset
   129
};