Added last history function descriptions

[CleanReadLine.git] / ReadLine.dcl

diff --git a/ReadLine.dcl b/ReadLine.dcl
index 5e529c1..30d3f4d 100644 (file)
--- a/ReadLine.dcl
+++ b/ReadLine.dcl
@@ -1,35 +1,54 @@
 definition module ReadLine
 
-:: HistoryItem = {line :: String, timestamp :: String}
+import StdClass
 
+:: Maybe a = Nothing | Just a
+:: HistoryItem = {line :: String, timestamp :: String}
 :: HistoryState = {entries :: [HistoryItem], offset :: Int, flags :: Int}
 
+instance toString HistoryItem
+instance toString HistoryState
+
+//Maybe functions
+isNothing :: !(Maybe .x) -> Bool
+isJust    :: !(Maybe .x) -> Bool
+fromJust  :: !(Maybe .x) -> .x
+
+//Non-library functions
+setReadLineName :: !String !*env -> *env
+
 //Readline
-readLine :: !String !Bool !*env -> (!String, !*env)
-setReadLineName :: !String !*env -> !*env
+readLine :: !String !Bool !*env -> (!Maybe String, !*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
+usingHistory :: !*env -> *env 
 historyGetHistoryState :: !*env -> (!HistoryState, !*env)
-historySetHistoryState :: !HistoryState !*env -> !*env
+historySetHistoryState :: !HistoryState !*env -> *env
 
 //History List Management
-addHistory :: !String !*env -> !*env
-clearHistory :: !*env -> !*env
-//TODO some more functions
+addHistory :: !String !*env -> *env
+addHistoryTime :: !String !*env -> *env
+removeHistory :: !Int !*env -> (!HistoryItem, !*env)
+replaceHistoryEntry :: !Int !String !*env -> (!HistoryItem, !*env)
+clearHistory :: !*env -> *env
+stifleHistory :: !Int !*env -> *env
+unstifleHistory :: !*env -> *env
+historyIsStifled :: !*env -> (!Int, !*env)
 
 //Information About the History List
-//TODO
+historyList :: !*env -> (![HistoryItem], !*env)
+whereHistory :: !*env -> (!Int, !*env)
+currentHistory :: !*env -> (!Maybe HistoryItem, !*env)
+historyGet :: !Int !*env -> (!Maybe HistoryItem, !*env)
+historyGetTime :: HistoryItem -> String
+historyTotalBytes :: !*env -> (!Int, !*env)
 
 //Moving Around the History List
-//TODO
+historySetPos :: !Int !*env -> (!Int, !*env)
+previousHistory :: !*env -> (!Maybe HistoryItem, !*env)
+nextHistory :: !*env -> (!Maybe HistoryItem, !*env)
 
 //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)
@@ -40,3 +59,9 @@ readHistoryRange :: !String !Int !Int !*env -> (!Bool, !*env)
 writeHistory :: !String !*env -> (!Bool, !*env)
 appendHistory :: !Int !String !*env -> (!Bool, !*env)
 historyTruncateFile :: !String !Int !*env -> (!Bool, !*env)
+
+//History Expansion
+historyExpand :: !String !*env -> (!String, !Int, !*env)
+getHistoryEvent :: !String !Int !Int !*env -> (!String, !*env)
+historyTokenize :: !String !*env -> ([String], !*env)
+historyArgExtract :: !Int !Int !String !*env -> (!String, !*env)