mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
This is an important refactor of the way documentation generation works
* Installs luarocks WITH it's executable (easy to install other rocks if necessary) * Use Lua supplied with luarocks * Create Utils/luadocumentor.bat, which works with RELATIVE PATH ! -> Everybody can generate the doc * Updated launch files accordingly
This commit is contained in:
106
Utils/luarocks/lua/luarocks/manif_core.lua
Normal file
106
Utils/luarocks/lua/luarocks/manif_core.lua
Normal file
@@ -0,0 +1,106 @@
|
||||
|
||||
--- Core functions for querying manifest files.
|
||||
-- This module requires no specific 'fs' functionality.
|
||||
local manif_core = {}
|
||||
package.loaded["luarocks.manif_core"] = manif_core
|
||||
|
||||
local persist = require("luarocks.persist")
|
||||
local type_check = require("luarocks.type_check")
|
||||
local cfg = require("luarocks.cfg")
|
||||
local dir = require("luarocks.dir")
|
||||
local util = require("luarocks.util")
|
||||
local path = require("luarocks.path")
|
||||
|
||||
-- Table with repository identifiers as keys and tables mapping
|
||||
-- Lua versions to cached loaded manifests as values.
|
||||
local manifest_cache = {}
|
||||
|
||||
--- Cache a loaded manifest.
|
||||
-- @param repo_url string: The repository identifier.
|
||||
-- @param lua_version string: Lua version in "5.x" format, defaults to installed version.
|
||||
-- @param manifest table: the manifest to be cached.
|
||||
function manif_core.cache_manifest(repo_url, lua_version, manifest)
|
||||
lua_version = lua_version or cfg.lua_version
|
||||
manifest_cache[repo_url] = manifest_cache[repo_url] or {}
|
||||
manifest_cache[repo_url][lua_version] = manifest
|
||||
end
|
||||
|
||||
--- Attempt to get cached loaded manifest.
|
||||
-- @param repo_url string: The repository identifier.
|
||||
-- @param lua_version string: Lua version in "5.x" format, defaults to installed version.
|
||||
-- @return table or nil: loaded manifest or nil if cache is empty.
|
||||
function manif_core.get_cached_manifest(repo_url, lua_version)
|
||||
lua_version = lua_version or cfg.lua_version
|
||||
return manifest_cache[repo_url] and manifest_cache[repo_url][lua_version]
|
||||
end
|
||||
|
||||
--- Back-end function that actually loads the manifest
|
||||
-- and stores it in the manifest cache.
|
||||
-- @param file string: The local filename of the manifest file.
|
||||
-- @param repo_url string: The repository identifier.
|
||||
-- @param lua_version string: Lua version in "5.x" format, defaults to installed version.
|
||||
-- @param quick boolean: If given, skips type checking.
|
||||
-- @return table or (nil, string, string): the manifest or nil,
|
||||
-- error message and error code ("open", "load", "run" or "type").
|
||||
function manif_core.manifest_loader(file, repo_url, lua_version, quick)
|
||||
local manifest, err, errcode = persist.load_into_table(file)
|
||||
if not manifest then
|
||||
return nil, "Failed loading manifest for "..repo_url..": "..err, errcode
|
||||
end
|
||||
local globals = err
|
||||
if not quick then
|
||||
local ok, err = type_check.type_check_manifest(manifest, globals)
|
||||
if not ok then
|
||||
return nil, "Error checking manifest: "..err, "type"
|
||||
end
|
||||
end
|
||||
|
||||
manif_core.cache_manifest(repo_url, lua_version, manifest)
|
||||
return manifest
|
||||
end
|
||||
|
||||
--- Load a local manifest describing a repository.
|
||||
-- All functions that use manifest tables assume they were obtained
|
||||
-- through either this function or load_manifest.
|
||||
-- @param repo_url string: URL or pathname for the repository.
|
||||
-- @return table or (nil, string, string): A table representing the manifest,
|
||||
-- or nil followed by an error message and an error code, see manifest_loader.
|
||||
function manif_core.load_local_manifest(repo_url)
|
||||
assert(type(repo_url) == "string")
|
||||
|
||||
local cached_manifest = manif_core.get_cached_manifest(repo_url)
|
||||
if cached_manifest then
|
||||
return cached_manifest
|
||||
end
|
||||
|
||||
local pathname = dir.path(repo_url, "manifest")
|
||||
return manif_core.manifest_loader(pathname, repo_url, nil, true)
|
||||
end
|
||||
|
||||
--- Get all versions of a package listed in a manifest file.
|
||||
-- @param name string: a package name.
|
||||
-- @param deps_mode string: "one", to use only the currently
|
||||
-- configured tree; "order" to select trees based on order
|
||||
-- (use the current tree and all trees below it on the list)
|
||||
-- or "all", to use all trees.
|
||||
-- @return table: An array of strings listing installed
|
||||
-- versions of a package.
|
||||
function manif_core.get_versions(name, deps_mode)
|
||||
assert(type(name) == "string")
|
||||
assert(type(deps_mode) == "string")
|
||||
|
||||
local version_set = {}
|
||||
path.map_trees(deps_mode, function(tree)
|
||||
local manifest = manif_core.load_local_manifest(path.rocks_dir(tree))
|
||||
|
||||
if manifest and manifest.repository[name] then
|
||||
for version in pairs(manifest.repository[name]) do
|
||||
version_set[version] = true
|
||||
end
|
||||
end
|
||||
end)
|
||||
|
||||
return util.keys(version_set)
|
||||
end
|
||||
|
||||
return manif_core
|
||||
Reference in New Issue
Block a user