Source/WebCore/page/Console.idl

   1 /*
   2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   8  * 1.  Redistributions of source code must retain the above copyright
   9  *     notice, this list of conditions and the following disclaimer.
  10  * 2.  Redistributions in binary form must reproduce the above copyright
  11  *     notice, this list of conditions and the following disclaimer in the
  12  *     documentation and/or other materials provided with the distribution.
  13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  14  *     its contributors may be used to endorse or promote products derived
  15  *     from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 module window {
  30
  31     interface [
  32         JSGenerateIsReachable=ImplFrame,
  33         OmitConstructor
  34     ] Console {
  35
  36         [CallWith=ScriptArguments|CallStack] void debug();
  37         [CallWith=ScriptArguments|CallStack] void error();
  38         [CallWith=ScriptArguments|CallStack] void info();
  39         [CallWith=ScriptArguments|CallStack] void log();
  40         [CallWith=ScriptArguments|CallStack] void warn();
  41         [CallWith=ScriptArguments|CallStack] void dir();
  42         [CallWith=ScriptArguments|CallStack] void dirxml();
  43         [V8Custom, CallWith=ScriptArguments|CallStack] void trace();
  44         [V8Custom, CallWith=ScriptArguments|CallStack, ImplementedAs=assertCondition] void assert(in boolean condition);
  45         [CallWith=ScriptArguments|CallStack] void count();
  46         [CallWith=ScriptArguments|CallStack] void markTimeline();
  47
  48 #if defined(ENABLE_JAVASCRIPT_DEBUGGER) && ENABLE_JAVASCRIPT_DEBUGGER
  49         // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
  50         // "Sequences must not be used as the type of an attribute, constant or exception field."
  51         // FIXME: this will lead to BUG console.profiles !== console.profiles as profile will always returns new array.
  52         readonly attribute ScriptProfile[] profiles;
  53         [Custom] void profile(in DOMString title);
  54         [Custom] void profileEnd(in DOMString title);
  55 #endif
  56
  57         void time(in [TreatNullAs=NullString, TreatUndefinedAs=NullString,Optional=DefaultIsUndefined] DOMString title);
  58         [CallWith=ScriptArguments|CallStack] void timeEnd(in [TreatNullAs=NullString, TreatUndefinedAs=NullString] DOMString title);
  59         [CallWith=ScriptArguments|CallStack] void timeStamp();
  60         [CallWith=ScriptArguments|CallStack] void group();
  61         [CallWith=ScriptArguments|CallStack] void groupCollapsed();
  62         void groupEnd();
  63
  64         readonly attribute [V8CustomGetter] MemoryInfo memory;
  65     };
  66
  67 }