extensions/Trace.as

   1 /* -*- c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 4 -*- */
   2 /* vi: set ts=4 sw=4 expandtab: (add to ~/.vimrc: set modeline modelines=5) */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is [Open Source Virtual Machine.].
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Adobe System Incorporated.
  20  * Portions created by the Initial Developer are Copyright (C) 1993-2006
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Adobe AS3 Team
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40
  41 package flash.trace
  42 {
  43     [native(cls="TraceClass", methods="auto")]
  44     public class Trace
  45     {
  46         /* levels of desired logging */
  47         public static const OFF:int = 0;
  48         public static const METHODS:int = 1;                        // method entry only
  49         public static const METHODS_WITH_ARGS:int = 2;              // method entry and arguments
  50         public static const METHODS_AND_LINES:int = 3;              // method entry and line numbers
  51         public static const METHODS_AND_LINES_WITH_ARGS:int = 4;    // method entry, arguments and line numbers
  52
  53         /* used to select either file or listener callback logging. */
  54         public static const FILE = 1;
  55         public static const LISTENER = 2;
  56
  57         public static native function setLevel(l:int, target:int=LISTENER);
  58         public static native function getLevel(target:int=LISTENER):int;
  59
  60         /**
  61          * Register a listener to receive trace callbacks upon method and/or
  62          * line number changes.  Passing null to this function effectively
  63          * 'unregisters' the listener and only a single listener can
  64          *  be specified.
  65          *
  66          *  The callback funcition must have the following signature:
  67          *
  68          *     function foo(file_name:String, linenum:int, method_name:String, method_args:String):void
  69          *
  70          *  Depending upon the setting of the trace level, 2 or more arguments may be non-empty.
  71          *  In all cases file_name and method_name are obtained and passed to the callback.  If
  72          *  the trace level include line numbers information then this value is also obtained
  73          *  and passed into the callback.  Setting the trace level to include method arguments implies
  74          *  that the 'method_args' parameter will be filled with string representation of the arguments
  75          *  passed into the call.
  76          */
  77         public static native function setListener(f:Function);
  78         public static native function getListener():Function;
  79     };
  80 };