update

[CleanReadLine.git] / ReadLine.dcl

diff --git a/ReadLine.dcl b/ReadLine.dcl
index da953d7..ecc58bf 100644 (file)
--- a/ReadLine.dcl
+++ b/ReadLine.dcl
@@ -1,8 +1,36 @@
 definition module ReadLine
 
-/*
-       Reads a line from stdin with the readline library
-       The value in the String argument will be used as a prompt
-       To enable history the Boolean variable has to be set to True
-*/
+//Readline
 readLine :: !String !Bool !*env -> (!String, !*env)
+setReadLineName :: !String !*env -> !*env
+
+//Initializing History and State Management
+//Note that this HAS to be executed when you want to add entries when the
+//history has not been used
+usingHistory :: !*env -> !*env
+
+//History List Management
+addHistory :: !String !*env -> !*env
+clearHistory :: !*env -> !*env
+//TODO some more functions
+
+//Information About the History List
+//TODO
+
+//Moving Around the History List
+//TODO
+
+//Searching the History List
+//Note that the return integers are just success flags. The actual found item
+//will be the current history position and the int is the offset of the search
+//within that item...
+historySearch :: !String !Int !*env-> (!Int, !*env)
+historySearchPrefix :: !String !Int !*env-> (!Int, !*env)
+historySearchPos :: !String !Int !Int !*env-> (!Int, !*env)
+
+//Managing the History File
+readHistory :: !String !*env -> (!Bool, !*env)
+readHistoryRange :: !String !Int !Int !*env -> (!Bool, !*env)
+writeHistory :: !String !*env -> (!Bool, !*env)
+appendHistory :: !Int !String !*env -> (!Bool, !*env)
+historyTruncateFile :: !String !Int !*env -> (!Bool, !*env)