Merge pull request #539 from Jafaral/json-logger-lib

uni: move jsonrpc and logger to lib

Author: Jafaral

uni/lib/Makefile

@@ -18,7 +18,7 @@ UFILES=gui.u file_dlg.u db.u \
  undoableedit.u undomanager.u url.u webup.u \
  notification.u md5.u httprequest.u httpresponse.u exception.u \
  thread.u matrix_util.u struct.u db_util.u database.u addressdb.u \
- union.u pdb_util.u propertydb.u property.u utf8.u unittest.u
+ union.u pdb_util.u propertydb.u property.u utf8.u unittest.u jsonrpc.u logger.u
 
 # COPYINS are library files copied in from other directories for
 # organizational purposes. Inspired by ipl/lib.  They have to be

uni/ulsp/jsonrpc.icn uni/lib/jsonrpc.icnuni/ulsp/jsonrpc.icn renamed to uni/lib/jsonrpc.icn

@@ -31,14 +31,16 @@
 #  In case of an error, and error objet should bre returned.
 #
 
-package ulsp
-import json
+package json
 link ximage
 
 $define CONTENT_LENGTH "Content-Length: "
 
+# JRPC_Message is a class that represents a JSON-RPC message
+# It is used to parse the JSON-RPC message and to create the JSON-RPC message
 class JRPC_Message(msg, kind, json_table)
 
+   # Parse the JSON-RPC message and set the kind of the message
    method parse_json(s)
       msg := s
       if json_table := jtou(s) then {
@@ -48,6 +50,7 @@ class JRPC_Message(msg, kind, json_table)
          kind := "unknown"
    end
 
+   # Guess the kind of the message based on the JSON-RPC message
    method guess_kind()
       #if we have a method, the msg is a request
       if \json_table["method"] then
@@ -58,59 +61,76 @@ class JRPC_Message(msg, kind, json_table)
          kind := "response"
       else
          kind := "unknown"
+
+      return kind
    end
 
+   # Get the JSON RPC kind of the message
    method get_kind()
       return kind
    end
+   # Get the JSON RPC id of the message
    method get_id()
       return json_table["id"]
    end
+   # Get the JSON RPC method of the message
    method get_method()
       return json_table["method"]
    end
+   # Get the JSON RPC params of the message
    method get_params()
       return json_table["params"]
    end
    # many requests operate on a file, stored in uri param
+   # used by ulsp server to get the file path
    method get_param_uri()
       return json_table["params"]["textDocument"]["uri"]
    end
 
+   # Get the result of returned by a json rpc request
    method get_result()
       return json_table["result"]
    end
+   # Get the error of returned by a json rpc request
    method get_error()
       return json_table["error"]
    end
+   # Get the raw message content
    method get_content()
       return msg
    end
 
+   # Initialize the JSON RPC message
    method init_msg()
       /json_table := ["jsonrpc" : "2.0"]
    end
 
+   # Set the result of the JSON RPC message
    method set_result(result)
       json_table["result"] := result
    end
+   # Set the id of the JSON RPC message
    method set_id(id)
       return json_table["id"] := id
    end
+   # Set the method of the JSON RPC message
    method set_method(meth)
       return json_table["method"] := meth
    end
+   # Set the params of the JSON RPC message
    method set_params(params)
       return json_table["params"] := params
    end
 
+   # Make a result response JSON RPC message
    method make_result_response(result)
       delete(json_table, "method", "params", "error")
       json_table["result"] := \result | ""
       if msg := tojson(json_table) then
          return self
    end
 
+   # Make a request JSON RPC message
    method make_request(id, meth, params)
       if /json_table then
          json_table := [
@@ -176,6 +196,7 @@ class JRPC_Message(msg, kind, json_table)
    #
    # RequestCancelled: -32800;
 
+   # Make an error response JSON RPC message
    method make_error_response(err_code, err_msg, err_data)
       delete(json_table, "method", "params", "result")
       json_table["error"] := [
@@ -187,6 +208,7 @@ class JRPC_Message(msg, kind, json_table)
          return self
    end
 
+   # Initialize the JSON RPC message
    initially
       kind := "unknown"
 end
@@ -227,6 +249,7 @@ class JRPC_HTTPSocket(sock)
       }
    end
 
+   # Get the data from the socket
    method get_data(size, timeout)
       local data := ""
       /timeout := -1
@@ -238,6 +261,7 @@ class JRPC_HTTPSocket(sock)
          return data
    end
 
+   # Get the JSON RPC message from the socket
    method get_msg(timeout)
       local msg_body, len
       len := get_http_header(timeout) | fail
@@ -247,12 +271,14 @@ class JRPC_HTTPSocket(sock)
       }
    end
 
+   # Send the JSON RPC message to the socket
    method send_msg(msg)
       local data
       data := msg.get_content()
       writes(sock, CONTENT_LENGTH, *data, "\r\n\r\n", data)
    end
 
+   # Initialize the JSON RPC HTTPSocket
    initially(addr, opt)
       if string(addr) then
          sock := open(addr,opt)

uni/ulsp/logger.icn uni/lib/logger.icnuni/ulsp/logger.icn renamed to uni/lib/logger.icn

@@ -51,7 +51,7 @@
 # TODO: Make the class thread-safe
 #
 
-package ulsp
+package logger
 
 link strings
 

uni/ulsp/Makefile

@@ -6,9 +6,9 @@ UFLAGS=-s -u
 prog=ulsp
 
 SRC=launch-lsp.icn file_handler.icn database.icn server.icn completion.icn signature.icn hover.icn \
-	definition.icn jsonrpc.icn logger.icn lsif.icn symbols.icn folding.icn formatting.icn
+	definition.icn lsif.icn symbols.icn folding.icn formatting.icn
 OBJ=launch-lsp.u file_handler.u database.u server.u completion.u signature.u hover.u definition.u \
-	jsonrpc.u logger.u lsif.u symbols.u folding.u formatting.u
+	lsif.u symbols.u folding.u formatting.u
 
 export IPATH=$(UNI)/unidoc
 
@@ -19,14 +19,14 @@ $(prog): $(OBJ)
 	$(UC) -o $(prog) $(OBJ)
 	$(CP) $(prog)$(EXE) ../../bin
 
-jsonrpc-test: jsonrpc-test.u jsonrpc.u
-	$(UC) -o jsonrpc-test jsonrpc-test.u jsonrpc.u
+jsonrpc-test: jsonrpc-test.u
+	$(UC) -o jsonrpc-test jsonrpc-test.u
 
 launch-lsp.u:launch-lsp.icn file_handler.u database.u server.u completion.u signature.u hover.u \
 				 definition.u symbols.u folding.u formatting.u
 
-server.u:server.icn database.u completion.u file_handler.u signature.u hover.u definition.u jsonrpc.u \
-		   logger.u symbols.u folding.u formatting.u
+server.u:server.icn database.u completion.u file_handler.u signature.u hover.u definition.u \
+		   symbols.u folding.u formatting.u
 hover.u:hover.icn signature.u
 definition.u: definition.icn hover.u
 

uni/ulsp/database.icn

@@ -10,10 +10,11 @@
 
 package ulsp
 
+
 import UniDoc
 link paths
+import logger
 
-global Logger
 
 class LSPDB(
    package_db,

uni/ulsp/jsonrpc-test.icn

@@ -1,4 +1,5 @@
 import ulsp
+import json
 
 global work_items
 

uni/ulsp/launch-lsp.icn

@@ -8,6 +8,7 @@
 #   -Instantiates Server class and calls run() to start server on validated port number.
 #
 import ulsp
+import logger
 link options
 link basename
 link ximage

uni/ulsp/lsif.icn

@@ -1,6 +1,7 @@
 import UniDoc
 import ulsp
 import json
+import logger
 link ximage
 
 #<p>

uni/ulsp/server.icn

@@ -11,6 +11,7 @@ package ulsp
 link ximage
 link strings
 import json
+import logger
 #import UniDoc