Examples and descriptions¶

system = {
  -- a default value of limiting the depth of the search path --
  default_search_path_depth = 2,

  -- should show icons on listbox? --
  enable_icons = true,

  -- an icon theme : meaningful only for Linux platforms --
  icon_theme = "nuoveXT.2.2",

  -- a maximum number of cached icon data --
  max_cached_icons = 9999,

  -- show completion candidates after N ms since the last key input --
  -- you can suppress unnecessary completions by setting this value on low-end machines --
  key_event_threshold = 0,

  -- a maximum number of commands to remember on the history file --
  max_histories = 500,

  -- a maximum number of candidates on the listbox --
  max_candidates = 15,

  -- a maximum number of clipboard histories : meaningful only for Windows platforms --
  max_clipboard_histories = 15,

  -- degree of influence of histories on completion candidates sorting(0.0~1.0) --
  history_factor = 0.8,

  -- an application to handle directories. ${1} will be replaced with a directory path --
  file_browser = [[explorer ${1}]],

  -- an application to handle CUI applications. ${1} will be replaced with a command text. This application must be executed as a login shell --
  terminal = [[lxterminal -l -e ${1}]],

  -- a port number to accept commands from external processes.(0: disabled) --
  server_port = 13505,

  -- should do autocompletion in a path completion --
  path_autocomplete = true,

  -- should do autocompletion in an option completion --
  option_autocomplete = true,

  -- do not use DirectWrite --
  disable_direct_write = false,

  -- DirectWrite parameters. an empty string means using default parameter --
  direct_write_params="gamma=1.8,enchanced_contrast=0.5,clear_type_level=0.5,pixel_geometry=0,rendering_mode=5",

  -- Keys --
  -- hot_key accepts OS dependent virtual key codes --
  --   Example: hot_key = "0x1d"  muhenkan(jp106 keyboard layout) --
  hot_key = "ctrl-space",
  escape_key = "escape",
  list_next_key = "ctrl-n",
  list_prev_key = "ctrl-p",
  toggle_mode_key = "ctrl-r",
  kill_word_key = "ctrl-w",

  -- Search paths --
  search_path = {
    {category="system", path = [[C:\Windows\System32]], depth = 1, pattern="^.*\\.(exe)$"},
    {category="programs", path = [[C:\Users\]] .. os.getenv("USERNAME") .. [[\AppData\Roaming\Microsoft\Windows\Start Menu\Programs]], depth = 10, pattern=[[^.*\.(exe|lnk)$]]},
    {category="programs", path = [[C:\ProgramData\Microsoft\Windows\Start Menu\Programs]], depth = 10, pattern=[[^.*\.(exe|lnk)$]]},
  },

  -- Completions --
  completer = {
    -- a command name completion: fuzzy match --
    command = ibs.COMP_ABBR,

    -- a path completion: prefix match --
    path    = ibs.COMP_BEGINSWITH,

    -- a history completion: partial match --
    history = ibs.COMP_PARTIAL,

    -- an option completion --
    option  = ibs.COMP_PARTIAL,

    -- completion functions --
    option_func = {
      [":scan_search_path"] = function(values, pos)
        local candidates = {"all"}
        local keys       = {all = true}
        for i, value in ipairs(system.search_path) do
          if value.category ~= nil and keys[value.category] == nil then
            table.insert(candidates, value.category)
            keys[value.category] = true
          end
        end
        return candidates
      end
    }
  }
}

Search paths¶

iceberg can search under search paths and register found commands by single command( :scan_search_path ). A search path consists of

Completion functions¶

Commands can have a completion function.

function(values, pos)
  return {"a", "b", "c"}
end

-- もしくは

function(values, pos)
  return {
   {value="a", icon="path_to/icon.png", description="desc"},
   {value="b", icon="path_to/icon.jpg", description="desc"},
   {value="c", icon="path_to/icon.gif", description="desc"}
  }
end

values is a list of arguments for the command. If no argument exists, value will be a list that has single empty string entry. pos is an index of value where cursor exists. Completion functions have to return the list of strings or a table contains following keys:

Please refer to icebergsupport.comp_state() for writing a complex completion function.

Examples¶

commands = {
  -- A directory, will not be recorded in the history file --
  windir = {path = [[C:\Windows]], history = false},

  -- An executable file, runs with a iceberg current directory --
  np = {path = [[notepad.exe]], description="Notepad", workdir="."},

  -- An executable file, will be run as an administrator user
  admin_cmd = {path = [[cmd.exe]], description="cmd.exe(runas admin)", sudo = true},

  -- A shell script file, executed in the terminal --
  np = {path = [[myscript.sh]], description="My script", terminal="yes"},

  -- A lua function, has a completion function --
  lua_sample = {
    path = function(args)
      local explorer = wins.foreground_explorer()
      if explorer then
        ibs.message(ibs.table_to_string(explorer))
      end
    end,
    completion = function(values, pos)
      return {"1","2","3"}
    end
    description="Sample Lua command"},


  -- A URL, has a png icon file --
  google = { path = [[http://www.google.com/search?ie=utf8&q=${1}]], description=[[Searches words on Google]], history=false,
       icon = script_path ..[[images\google256.png]]},

  -- A group of commands --
  group_sample = { path = ibs.group_command({"windir", {}}, {"np", {}}), description = "runs a group of commands"},

}

Commands¶

Commands consist of

path = [["C:\s p a c e\bin.exe" arg1 arg2]]

path = [[http://www.google.com/search?ie=utf8&q=${1}]]

Examples¶

shortcuts = {
  { key = "ctrl-d", name = ":opendir" },
  { key = "ctrl-l", name = ":cd" }
}

Consider, when you have pressed ctrl-l and the inputbox values is c:\ . In this situation, the following command will be executed

:cd c:\

In short, an inputbox value is passed as an argument to the command.