Changeset 12523

Timestamp:

03/11/10 08:42:48 (13 years ago)

Author:

Mark Evenson

Message:

Add informal BNF grammar description for JAR PATHNAME syntax.

File:

• trunk/abcl/doc/design/pathnames/abcl-jar-url.text (modified) (1 diff)

trunk/abcl/doc/design/pathnames/abcl-jar-url.text

@@ -90 +90 @@
     innermost.
     
+*   The DIRECTORY component of a JAR PATHNAME should be a list starting
+    with the :RELATIVE keyword, as hierarchial entries in jar files
+    are of the form "foo/bar/a.lisp" not "/foo/bar/a.lisp"
+
+BNF
+---
+
+An incomplete BNF of the syntax of JAR PATHNAME would be:
+
+  JAR-PATHNAME ::= "jar:" URL "!/" [ ENTRY ]
+
+  URL ::= <URL parsable via java.net.URL.URL()>
+        | JAR-FILE-PATHNAME
+  
+  JAR-FILE-PATHNAME ::= "jar:" "file:" JAR-NAMESTRING "!/" [ ENTRY ]
+
+  JAR-NAMESTRING  ::=  ABSOLUTE-FILE-NAMESTRING
+                     | RELATIVE-FILE-NAMESTRING
+
+  ENTRY ::= [ DIRECTORY "/"] * FILE
+
+
+### Notes
+
+1.  ABSOLUTE-FILE-NAMESTRING and RELATIVE-FILE-NAMESTRING use the
+local filesystem conventions, meaning that on Windows this could
+contain '\' as the directory separator, while an ENTRY always uses '/'
+to separate directories within the jar proper.