arangodb/js/common/bootstrap/print.js

////////////////////////////////////////////////////////////////////////////////
/// @brief printing
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2012 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2011-2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

var internal = require("internal");

// -----------------------------------------------------------------------------
// --SECTION--                                                          printing
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup V8Shell
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief prints objects to standard output
///
/// @FUN{print(@FA{arg1}, @FA{arg2}, @FA{arg3}, ...)}
///
/// Only available in shell mode.
///
/// Prints the arguments. If an argument is an object having a
/// function @FN{_PRINT}, then this function is called. Otherwise @FN{toJson} is
/// used.  A final newline is printed
///
/// @verbinclude fluent40
////////////////////////////////////////////////////////////////////////////////

function print () {
  for (var i = 0;  i < arguments.length;  ++i) {
    if (0 < i) {
      internal.output(" ");
    }

    if (typeof(arguments[i]) === "string") {
      internal.output(arguments[i]);      
    } 
    else {
      PRINT(arguments[i], [], "~", [], 0);
    }
  }

  if (typeof(COLOR_OUTPUT) != "undefined" && typeof(COLOR_OUTPUT_RESET) != "undefined") {
    internal.output(COLOR_OUTPUT_RESET);
  }

  internal.output("\n");
}

var characterQuoteCache = {
  '\b': '\\b', // ASCII 8, Backspace
  '\t': '\\t', // ASCII 9, Tab
  '\n': '\\n', // ASCII 10, Newline
  '\f': '\\f', // ASCII 12, Formfeed
  '\r': '\\r', // ASCII 13, Carriage Return
  '\"': '\\"',
  '\\': '\\\\'
};

function QuoteSingleJSONCharacter(c) {
  if (c in characterQuoteCache) {
    return characterQuoteCache[c];
  }
  var charCode = c.charCodeAt(0);
  var result;
  if (charCode < 16) result = '\\u000';
  else if (charCode < 256) result = '\\u00';
  else if (charCode < 4096) result = '\\u0';
  else result = '\\u';
  result += charCode.toString(16);
  characterQuoteCache[c] = result;
  return result;
}

function QuoteJSONString(str) {
 var quotable = /[\\\"\x00-\x1f]/g;
 return '"' + str.replace(quotable, QuoteSingleJSONCharacter) + '"';
}


////////////////////////////////////////////////////////////////////////////////
/// @brief prints objects to standard output without a new-line
////////////////////////////////////////////////////////////////////////////////

function PRINT (value, seen, path, names, level) {
  var p;

  if (seen === undefined) {
    seen = [];
    names = [];
  }

  p = seen.indexOf(value);

  if (0 <= p) {
    internal.output(names[p]);
  }
  else {
    if (value instanceof Object) {
      seen.push(value);
      names.push(path);
    }

    if (value instanceof Object) {
      if ('_PRINT' in value) {
        value._PRINT(seen, path, names, level);
      }
      else if (value.__proto__ === Object.prototype) {
        PRINT_OBJECT(value, seen, path, names, level);
      }
      else if ('toString' in value) {
        internal.output(value.toString());
      }
      else {
        PRINT_OBJECT(value, seen, path, names, level);
      }
    }
    else if (value === undefined) {
      internal.output("undefined");
    }
    else {
      if (typeof(value) === "string") {
        internal.output(QuoteJSONString(value));
      } 
      else {
        internal.output("" + value);        
      }
    }
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////

// -----------------------------------------------------------------------------
// --SECTION--                                                             Array
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup V8Shell
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief JSON representation of an array
////////////////////////////////////////////////////////////////////////////////

Array.prototype._PRINT = function(seen, path, names, level) {
  if (this.length == 0) {
    internal.output("[ ]");
  }
  else {
    var sep = "";

    internal.output("[");
    
    var newLevel = level + 1;
    
    for (var i = 0;  i < this.length;  i++) {
      internal.output(sep);
      
      printIdent(newLevel);
      
      PRINT(this[i], seen, path + "[" + i + "]", names, newLevel);
      sep = ", ";
    }

    printIdent(level);

    internal.output("]");
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////

// -----------------------------------------------------------------------------
// --SECTION--                                                          Function
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup V8Shell
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief prints a function
////////////////////////////////////////////////////////////////////////////////

Function.prototype._PRINT = function() {
  internal.output(this.toString());
}

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////

// -----------------------------------------------------------------------------
// --SECTION--                                                            Object
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup V8Shell
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief string representation of an object
////////////////////////////////////////////////////////////////////////////////

function PRINT_OBJECT (object, seen, path, names, level) {
  var sep = " ";

  internal.output("{");

  var newLevel = level + 1;

  for (var k in object) {
    if (object.hasOwnProperty(k)) {
      var val = object[k];

      internal.output(sep);
      
      printIdent(newLevel);
      
      if ( typeof(COLOR_OUTPUT) != "undefined") {
        internal.output(COLOR_OUTPUT, k, COLOR_OUTPUT_RESET, " : ");
      }
      else {
        internal.output(QuoteJSONString(k), " : ");        
      }
      PRINT(val, seen, path + "[" + k + "]", names, newLevel);
      sep = ", ";
    }
  }

  printIdent(level);
  
  internal.output(" }");
}

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////


////////////////////////////////////////////////////////////////////////////////
/// @addtogroup V8Shell
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief prints the ident for pretty printing
///
/// @FUN{printIdent(@FA{level})}
///
/// Only available in shell mode.
////////////////////////////////////////////////////////////////////////////////

function printIdent(level) {
  if (typeof(PRETTY_PRINT) != "undefined" && PRETTY_PRINT) {
      internal.output("\n");    
      for (var j = 0; j < level; ++j) {
        internal.output("  ");    
      }    
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////

// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @}\\)"
// End: