function-template.js

/* NEW BSD LICENSE {{{
Copyright (c) 2009, anekos.
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice,
       this list of conditions and the following disclaimer.
    2. Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
    3. The names of the authors may not be used to endorse or promote products
       derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
THE POSSIBILITY OF SUCH DAMAGE.


###################################################################################
# http://sourceforge.jp/projects/opensource/wiki/licenses%2Fnew_BSD_license       #
# に参考になる日本語訳がありますが、有効なのは上記英文となります。                #
###################################################################################

}}} */

// PLUGIN_INFO {{{
let PLUGIN_INFO =
<VimperatorPlugin>
  <name>Functions Template</name>
  <name lang="ja">関数テンプレート</name>
  <description>function Template</description>
  <description lang="ja">Vimperator の関数のテンプレート</description>
  <version>1.2.0</version>
  <author mail="anekos@snca.net" homepage="http://d.hatena.ne.jp/nokturnalmortum/">anekos</author>
  <license>new BSD License (Please read the source code comments of this plugin)</license>
  <license lang="ja">修正BSDライセンス (ソースコードのコメントを参照してください)</license>
  <updateURL>https://github.com/vimpr/vimperator-plugins/raw/master/function-template.js</updateURL>
  <minVersion>2.3</minVersion>
  <maxVersion>2.3</maxVersion>
  <detail><![CDATA[
    Functions template
    (Fix|Add) me!
  ]]></detail>
  <detail lang="ja"><![CDATA[
    関数のテンプレート
    (おかしい|書かれていない)(関数|引数|説明)があったら適当に(足|なお)してください。
  ]]></detail>
</VimperatorPlugin>;
// }}}

(function () {
  // XXX 以下は実行しないよ。
  return;


  commands.addUserCommand(
    ['co[mmand1]'],
    'Description',
    function (args) {
      args.literalArg;
      args.length;
      args.bang;          // :command!
      args.count;         // :10command  入力されていない時は -1
      args['-option1'];
    },
    {
      literal: 0,
      bang: true,
      count: true,
      argCount: '*', // 0 1 + * ?
      options: [
        [['-force'], commands.OPTION_NOARG],
        [['-fullscreen', '-f'], commands.OPTION_BOOL],
        [['-language'], commands.OPTION_STRING, null, [['perl', 'llama'], ['ruby', 'rabbit']]],
        [['-speed'], commands.OPTION_INT],
        [['-acceleration'], commands.OPTION_FLOAT],
        [['-accessories'], commands.OPTION_LIST, validaterFunc, ['foo', 'bar']],
        [['-other'], commands.OPTION_ANY]
      ],
      completer: function (context, args) {
        context.title = ['value', 'description'];
        context.filters = [CompletionContext.Filter.textDescription]; // 説明(desc)もフィルタリング対象にする
        context.completions = [
          ['item1', 'desc1'],
        ];
      }
    },
    true // replace
  );


  options.add(
    ['names'],
    'description',
    'string', // type: string, stringlist, charlist, boolean
    'defaultValue',
    {
      scope: Option.SCOPE_GLOBAL, // <- default
                                  // or Option.SCOPE_LOCAL, Option.SCOPE_BOTH
      setter: function (value) {
        /* mozo mozo */
        return value;
      },
      getter: function (value) {
        /* mozo mozo */
        return value;
      },
      completer: function () {
      },
      validator: function () {
      },
      checkHas: function () {
      }
    }
  );


  hints.addMode(
    'm', // mode char
    'description',
    function (elem, loc, count) {
    },
    function () '//*'
  );


  mappings.addUserMap(
    [modes.NORMAL, modes.INSERT, modes.COMMAND_LINE, modes.VISUAL],
    ['`moge'],
    'Description',
    // extraInfo で指定していない引数は渡されません
    //   count => 入力されていない場合は - 1
    function (motion, count, arg) {
    },
    {
      noremap: true,
      silent: true,
      rhs: '`rhs',
      motion: true,
      count: true,
      arg: true
    }
  );


  autocommands.add(
    'LocationChange',
    '.*',
    function (args) {
      args.url;
      args.state // at Fullscreen
    }
    // or 'js ex-command'
  );

})();

// vim:sw=2 ts=2 et si fdm=marker: