From 0807209928f01e95669af6aeb671110209774bc6 Mon Sep 17 00:00:00 2001
From: Tuukka Lehtonen <tuukka.lehtonen@semantum.fi>
Date: Tue, 14 Nov 2017 08:51:05 +0200
Subject: [PATCH] Added StringIO.readContentsWithCharset

refs #7615

Change-Id: I8dd435df65cb8273d2be28db47cd3fef8ed60d7d
---
 .../org.simantics.scl.runtime/scl/StringIO.md  | 14 ++++++++++++--
 .../org.simantics.scl.runtime/scl/StringIO.scl | 18 +++++++++++++++---
 .../scl/runtime/procedure/StringIO.java        | 12 +++++++++++-
 3 files changed, 38 insertions(+), 6 deletions(-)

diff --git a/bundles/org.simantics.scl.runtime/scl/StringIO.md b/bundles/org.simantics.scl.runtime/scl/StringIO.md
index 7013c2ebb..013b94cab 100644
--- a/bundles/org.simantics.scl.runtime/scl/StringIO.md
+++ b/bundles/org.simantics.scl.runtime/scl/StringIO.md
@@ -1,5 +1,15 @@
 # StringIO
 
-# Undocumented entities
+This module contains file I/O related functions that read and
+write contents of textual files into/from String instances.
 
-::undocumented[]
\ No newline at end of file
+## Reading
+
+::value[readLines]
+::value[readLinesWithCharset]
+::value[readContentsWithCharset]
+
+## Writing
+
+::value[writeLines]
+::value[appendLine]
diff --git a/bundles/org.simantics.scl.runtime/scl/StringIO.scl b/bundles/org.simantics.scl.runtime/scl/StringIO.scl
index 1971afc83..a6bf0bffa 100644
--- a/bundles/org.simantics.scl.runtime/scl/StringIO.scl
+++ b/bundles/org.simantics.scl.runtime/scl/StringIO.scl
@@ -1,13 +1,25 @@
 
 importJava "org.simantics.scl.runtime.procedure.StringIO" where
-    "Reads all lines of the file whose name is given as a parameter"
+    """
+    Reads all lines of the file whose name is given as a parameter.
+    The file contents are expected to be UTF8 encoded.
+    """
     readLines :: String -> <Proc> [String]
     
     "`readLinesWithCharset \"charset\" \"file\"` reads all lines of the file whose name is given as a parameter using the given charset."
     readLinesWithCharset :: String -> String -> <Proc> [String]
     
-    "Creates a new file with the given file name whose contents are the given lines."
+    "`readContentsWithCharset \"charset\" \"file\"` reads all lines of the file whose name is given as a parameter using the given charset."
+    readContentsWithCharset :: String -> String -> <Proc> String
+    
+    """
+    Creates a new file with the given file name whose contents are the given lines.
+    The written file will be UTF8 encoded.
+    """
     writeLines :: String -> [String] -> <Proc> ()
     
-    "`appendLine fileName line` appends `line` to the file with name `fileName`"
+    """
+    `appendLine fileName line` appends `line` to the file with name `fileName`
+    The appended content will be UTF8 encoded.
+    """
     appendLine :: String -> String -> <Proc> ()
diff --git a/bundles/org.simantics.scl.runtime/src/org/simantics/scl/runtime/procedure/StringIO.java b/bundles/org.simantics.scl.runtime/src/org/simantics/scl/runtime/procedure/StringIO.java
index a3a25933e..82d3a9f32 100644
--- a/bundles/org.simantics.scl.runtime/src/org/simantics/scl/runtime/procedure/StringIO.java
+++ b/bundles/org.simantics.scl.runtime/src/org/simantics/scl/runtime/procedure/StringIO.java
@@ -27,7 +27,16 @@ public class StringIO {
             throw new RuntimeException("Encoding of the file '" + fileName + "' does not conform to " + charset + ".");
         }
     }
-    
+
+    public static String readContentsWithCharset(String charset, String fileName) throws IOException {
+        try {
+            Charset cs = Charset.forName(charset);
+            return new String(Files.readAllBytes(Paths.get(fileName)), cs);
+        } catch(MalformedInputException e) {
+            throw new RuntimeException("Encoding of the file '" + fileName + "' does not conform to " + charset + ".");
+        }
+    }
+
     public static void writeLines(String fileName, List<String> lines) throws IOException {
         BufferedWriter writer = Files.newBufferedWriter(Paths.get(fileName), UTF8);
         for(String line : lines) {
@@ -44,4 +53,5 @@ public class StringIO {
         writer.write("\n");
         writer.close();
     }
+
 }
-- 
2.43.2