-- Copyright 2007-2011 Mitchell mitchell<att>caladbolg.net. See LICENSE.
-- This is a DUMMY FILE used for making LuaDoc for built-in functions in the
-- _G table.

--- Extends Lua's _G table to provide extra functions and fields.
module('_G')

-- Markdown:
-- ## Fields
--
-- * `_HOME` [string]: Path to the directory containing Textadept.
-- * `_LEXERPATH` [string]: Paths to lexers, formatted like
--   [`package.path`][package_path].
-- * `_RELEASE` [string]: The Textadept release version.
-- * `_THEME` [string]: The [theme](../manual/8_Themes.lua) file to use.
-- * `_USERHOME` [string]: Path to the user's `~/.textadept/`.
-- * `_CHARSET` [string]: The character set encoding of the filesystem. This is
--   used in [File I/O](../modules/io.html).
-- * `RESETTING` [bool]: If [`reset()`](../modules/_G.html#reset) has been
--   called, this flag is `true` while the Lua state is being re-initialized.
-- * `WIN32` [bool]: If Textadept is running on Windows, this flag is `true`.
-- * `OSX` [bool]: If Textadept is running on Mac OSX, this flag is `true`.
--
-- [package_path]: http://www.lua.org/manual/5.1/manual.html#pdf-package.path

---
-- Command line parameters.
-- @class table
-- @name arg
arg = {}


---
-- Table of all open buffers in Textadept.
-- Numeric keys have buffer values and buffer keys have their associated numeric
-- keys.
-- @class table
-- @name _BUFFERS
-- @usage _BUFFERS[1] contains the first buffer.
-- @usage _BUFFERS[buffer] returns the index of the current buffer in _BUFFERS.
_BUFFERS = {}

---
-- Table of all views in Textadept.
-- Numeric keys have view values and view keys have their associated numeric
-- keys.
-- @class table
-- @name _VIEWS
-- @usage _VIEWS[1] contains the first view.
-- @usage _VIEWS[view] returns the index of the current view in _VIEWS.
_VIEWS = {}

---
-- Creates a new buffer.
-- Generates a `BUFFER_NEW` event.
-- @return the new buffer.
function new_buffer() end

---
-- Calls a given function after an interval of time.
-- To repeatedly call the function, return true inside the function. A `nil` or
-- `false` return value stops repetition.
-- @param interval The interval in seconds to call the function after.
-- @param f The function to call.
-- @param ... Additional arguments to pass to `f`.
function timeout(interval, f, ...) end

---
-- Resets the Lua state by reloading all init scripts.
-- Language-specific modules for opened files are NOT reloaded. Re-opening the
-- files that use them will reload those modules.
-- This function is useful for modifying init scripts (such as the user's
-- `modules/textadept/keys.lua`) on the fly without having to restart Textadept.
-- `_G.RESETTING` is set to `true` when re-initing the Lua State. Any scripts
-- that need to differentiate between startup and reset can utilize this
-- variable.
function reset() end

---
-- Quits Textadept.
function quit() end

---
-- Calls `dofile()` on the given filename in the user's Textadept directory.
-- Errors are printed to the Textadept message buffer.
-- @param filename The name of the file (not path).
-- @return true if successful; false otherwise.
-- @see dofile
function user_dofile(filename) end