michael/lean2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc(lua): update Lua API documentation, and reactivate doc tests

Browse source 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
This commit is contained in:
Leonardo de Moura 2014-05-27 08:09:54 -07:00
parent 3608826e4c
commit 045a83153c
2 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
doc/lua/lua.md
View file

@ -29,8 +29,8 @@ assert(is_name(x)) -- test whether argument is a hierarchical name or not.
assert(not is_name("x")) assert(not is_name("x"))
local x1 = name(x, 1) -- x1 is a name composed of the string "x" and number 1 local x1 = name(x, 1) -- x1 is a name composed of the string "x" and number 1
assert(tostring(x1) == "x::1") assert(tostring(x1) == "x.1")
assert(x1 ~= name("x::1")) -- x1 is not equal to the string x::1 assert(x1 ~= name("x.1")) -- x1 is not equal to the string x.1
assert(x1 == name("x", 1)) assert(x1 == name("x", 1))
local o = name("lean", "pp", "colors") local o = name("lean", "pp", "colors")
@ -96,37 +96,37 @@ assert(m[a] == 10)
-- Lua tables assume that different instances are not equal -- Lua tables assume that different instances are not equal
``` ```
## Splay maps ## Red-black tree maps
In Lean, we provide splay maps for implementing mappings where the keys are In Lean, we provide red-black tree maps for implementing mappings where the keys are
Lean objects such as hierarchical names. A splay map is implemented using Lean objects such as hierarchical names. The maps are implemented on
a [splay tree](http://en.wikipedia.org/wiki/Splay_tree), a self-adjusting binary top of [red-black tree data structure](http://en.wikipedia.org/wiki/Red%E2%80%93black_tree).
search tree. We can also use Lua atomic data types We can also use Lua atomic data types as keys in these maps.
as keys in splay maps. However, we should not mix different types in the However, we should not mix different types in the same map.
same splay map. The Lean splay map assumes that `<` is a total order on the The Lean map assumes that `<` is a total order on the
keys inserted in the map. keys inserted in the map.
```lua ```lua
local m = splay_map() -- create an empty splay map local m = rb_map() -- create an empty red-black tree map
assert(is_splay_map(m)) assert(is_rb_map(m))
assert(#m == 0) assert(#m == 0)
local a = name("a", 1) local a = name("a", 1)
local a1 = name("a", 1) local a1 = name("a", 1)
m:insert(a, 10) -- add the entry 'a::1' -> 10 m:insert(a, 10) -- add the entry 'a.1' -> 10
assert(m:find(a1) == 10) assert(m:find(a1) == 10)
m:insert(name("b"), 20) m:insert(name("b"), 20)
assert(#m == 2) assert(#m == 2)
m:erase(a) -- remove entry with key 'a::1' m:erase(a) -- remove entry with key 'a.1'
assert(m:find(a) == nil) assert(m:find(a) == nil)
assert(not m:contains(a)) assert(not m:contains(a))
assert(#m == 1) assert(#m == 1)
m:insert(name("c"), 30) m:insert(name("c"), 30)
m:for_each( -- traverse the entries in the splay map m:for_each( -- traverse the entries in the map
function(k, v) -- executing the given function function(k, v) -- executing the given function
print(k, v) print(k, v)
end end
) )
local m2 = m:copy() -- the splay maps are copied in constant time local m2 = m:copy() -- the maps are copied in constant time
assert(#m2 == #m) assert(#m2 == #m)
m2:insert(name("b", 2), 40) m2:insert(name("b", 2), 40)
assert(#m2 == #m + 1) assert(#m2 == #m + 1)
@ -292,8 +292,8 @@ how to create options objects using Lua.
```lua ```lua
-- Create an options set containing the entries -- Create an options set containing the entries
-- pp::colors -> false, -- pp.colors -> false,
-- pp::unicode -> false -- pp.unicode -> false
local o1 = options(name("pp", "colors"), false, name("pp", "unicode"), false) local o1 = options(name("pp", "colors"), false, name("pp", "unicode"), false)
assert(is_options(o1)) assert(is_options(o1))
print(o1) print(o1)
@ -304,7 +304,7 @@ print(o2)
-- An error is raised if the option is not known. -- An error is raised if the option is not known.
local ok, ex = pcall(function() options({"pp", "foo"}, true) end) local ok, ex = pcall(function() options({"pp", "foo"}, true) end)
assert(not ok) assert(not ok)
assert(ex:what():find("unknown option 'pp::foo'")) assert(ex:what():find("unknown option 'pp.foo'"))
``` ```
Options objects are non-mutable values. The method `update` returns a new Options objects are non-mutable values. The method `update` returns a new

16
src/shell/CMakeLists.txt
View file

@ -85,14 +85,14 @@ ENDFOREACH(T)
# COMMAND "./test_single.sh" "${CMAKE_CURRENT_BINARY_DIR}/lean -t" ${T}) # COMMAND "./test_single.sh" "${CMAKE_CURRENT_BINARY_DIR}/lean -t" ${T})
# ENDFOREACH(T) # ENDFOREACH(T)
# # LEAN LUA DOCS # LEAN LUA DOCS
# file(GLOB LEANLUADOCS "${LEAN_SOURCE_DIR}/../doc/lua/*.md") file(GLOB LEANLUADOCS "${LEAN_SOURCE_DIR}/../doc/lua/*.md")
# FOREACH(T ${LEANLUADOCS}) FOREACH(T ${LEANLUADOCS})
# GET_FILENAME_COMPONENT(T_NAME ${T} NAME) GET_FILENAME_COMPONENT(T_NAME ${T} NAME)
# add_test(NAME "leanluadoc_${T_NAME}" add_test(NAME "leanluadoc_${T_NAME}"
# WORKING_DIRECTORY "${LEAN_SOURCE_DIR}/../doc/lua" WORKING_DIRECTORY "${LEAN_SOURCE_DIR}/../doc/lua"
# COMMAND "./test_single.sh" "${CMAKE_CURRENT_BINARY_DIR}/lean -t" ${T}) COMMAND "./test_single.sh" "${CMAKE_CURRENT_BINARY_DIR}/lean -t" ${T})
# ENDFOREACH(T) ENDFOREACH(T)
# LEAN LUA THREAD TESTS # LEAN LUA THREAD TESTS
if((${CYGWIN} EQUAL "1") OR (${CMAKE_SYSTEM_NAME} MATCHES "Linux")) if((${CYGWIN} EQUAL "1") OR (${CMAKE_SYSTEM_NAME} MATCHES "Linux"))