kateindentscript.cpp

Go to the documentation of this file.

// This file is part of the KDE libraries
// Copyright (C) 2008 Paul Giannaros <paul@giannaros.org>
// Copyright (C) 2009 Dominik Haumann <dhaumann kde org>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Library General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) version 3.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Library General Public License for more details.
//
// You should have received a copy of the GNU Library General Public License
// along with this library; see the file COPYING.LIB.  If not, write to
// the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
// Boston, MA 02110-1301, USA.

#include "kateindentscript.h"

#include <QScriptValue>
#include <QScriptEngine>

#include "katedocument.h"
#include "kateview.h"

KateIndentScript::KateIndentScript(const QString &url, const KateIndentScriptHeader &header)
  : KateScript(url)
  , m_triggerCharactersSet (false)
  , m_indentHeader(header)
{
}

const KateIndentScriptHeader& KateIndentScript::indentHeader() const
{
  return m_indentHeader;
}

const QString &KateIndentScript::triggerCharacters()
{
  // already set, perfect, just return...
  if (m_triggerCharactersSet)
    return m_triggerCharacters;

  m_triggerCharactersSet = true;

  m_triggerCharacters = global("triggerCharacters").toString();

  //kDebug( 13050 ) << "trigger chars: '" << m_triggerCharacters << "'";

  return m_triggerCharacters;
}

QPair<int, int> KateIndentScript::indent(KateView* view, const KTextEditor::Cursor& position,
                                         QChar typedCharacter, int indentWidth)
{
  // if it hasn't loaded or we can't load, return
  if(!setView(view))
    return qMakePair(-2,-2);

  clearExceptions();
  QScriptValue indentFunction = function("indent");
  if(!indentFunction.isValid()) {
    return qMakePair(-2,-2);
  }
  // add the arguments that we are going to pass to the function
  QScriptValueList arguments;
  arguments << QScriptValue(m_engine, position.line());
  arguments << QScriptValue(m_engine, indentWidth);
  arguments << QScriptValue(m_engine, typedCharacter.isNull() ? QString("") : QString(typedCharacter));
  // get the required indent
  QScriptValue result = indentFunction.call(QScriptValue(), arguments);
  // error during the calling?
  if(m_engine->hasUncaughtException()) {
    displayBacktrace(result, "Error calling indent()");
    return qMakePair(-2,-2);
  }
  int indentAmount = -2;
  int alignAmount = -2;
  if (result.isArray()) {
    indentAmount = result.property(0).toInt32();
    alignAmount = result.property(1).toInt32();
  } else {
    indentAmount = result.toInt32();
  }
  if(m_engine->hasUncaughtException()) {
    displayBacktrace(QScriptValue(), "Bad return type (must be integer)");
    return qMakePair(-2,-2);
  }
  return qMakePair(indentAmount, alignAmount);
}

// kate: space-indent on; indent-width 2; replace-tabs on;