Prepare for better record tags in printing

mikera · mikera · commit 307ebb353615 · 2024-09-30T08:52:57.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,11 +8,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Better CNS functionality
+- Support for tagged forms in Convex Reader
 - `dissoc-in`, `update` and `update-in` core functions
 - `switch` conditional macro
 
 ### Changed
 
+- Class hierarchy refactoring for `convex.core.cpos`
+- More GUI updates
 - `set!` now allows pending definitions
 
 ## [0.7.15] - 2024-09-17
diff --git a/convex-core/src/main/antlr4/convex/core/lang/reader/antlr/Convex.g4 b/convex-core/src/main/antlr4/convex/core/lang/reader/antlr/Convex.g4
@@ -1,9 +1,17 @@
 grammar Convex;
+
+/*  =========================================
+ *  Grammar for Convex Reader
+ *  =========================================
+ *  
+ *  Refers to tokens defined in the lexer at the bottom of this file
+ */ 
  
 form
 	: quoted
 	| pathSymbol
 	| primary
+	| taggedForm
 	;
 	
 primary
@@ -12,6 +20,8 @@ primary
 	| resolve
 	| atom
 	;
+	
+
 
 singleForm: form EOF;
 	
@@ -30,6 +40,10 @@ set : SET_LBR forms RBR;
 
 map : LBR forms RBR;
 
+taggedForm: tag form;
+
+tag: HASH_TAG;
+
 atom
   : symbol 
   | literal
diff --git a/convex-core/src/main/java/convex/core/data/AIndex.java b/convex-core/src/main/java/convex/core/data/AIndex.java
@@ -6,6 +6,7 @@
 
 import convex.core.data.type.AType;
 import convex.core.data.type.Types;
+import convex.core.data.util.BlobBuilder;
 
 /**
  * Abstract base class for Indexes: a sorted radix-tree map of Blobs to Values.
@@ -53,6 +54,12 @@ public Set<Entry<K, V>> entrySet() {
 		}
 		return Collections.unmodifiableSet(hs);
 	}
+	
+	@Override
+	public boolean print(BlobBuilder sb, long limit) {
+		sb.append("#Index ");
+		return super.print(sb, limit);
+	}
 
 	@Override
 	public abstract int getRefCount();
diff --git a/convex-core/src/main/java/convex/core/data/ARecord.java b/convex-core/src/main/java/convex/core/data/ARecord.java
@@ -7,6 +7,8 @@
 import convex.core.cpos.Block;
 import convex.core.data.type.AType;
 import convex.core.data.type.Types;
+import convex.core.data.util.BlobBuilder;
+import convex.core.lang.RT;
 import convex.core.lang.RecordFormat;
 
 /**
@@ -198,6 +200,29 @@ public MapEntry<Keyword, ACell> entryAt(long i) {
 		Keyword k=getFormat().getKeys().get(i);
 		return getEntry(k);
 	}
+	
+	@Override
+	public boolean print(BlobBuilder sb, long limit) {
+		AString tag=getType().getTag();
+		if (tag!=null) {
+			sb.append(tag);
+			sb.append(' ');
+		}
+		sb.append('{');
+		long n=count();
+		RecordFormat format=getFormat();
+		ACell[] vs=getValuesArray();
+		for (long i=0; i<n; i++) {
+			Keyword k=format.getKey(i);
+			if (!RT.print(sb,k,limit)) return false;
+			sb.append(' ');
+			ACell v=vs[(int)i];
+			if (!RT.print(sb,v,limit)) return false;
+			if (i<(n-1)) sb.append(',');
+		}
+		sb.append('}');
+		return sb.check(limit);
+	}
 
 	@Override
 	public MapEntry<Keyword, ACell> getEntry(ACell k) {
diff --git a/convex-core/src/main/java/convex/core/data/Cells.java b/convex-core/src/main/java/convex/core/data/Cells.java
@@ -4,6 +4,7 @@
 import java.lang.reflect.Array;
 import java.util.function.Consumer;
 
+import convex.core.exceptions.ParseException;
 import convex.core.store.AStore;
 import convex.core.store.Stores;
 
@@ -260,4 +261,17 @@ public static <T extends ACell> T intern(T value) {
 		return value;
 	}
 
+	@SuppressWarnings("unchecked")
+	public static ACell createTagged(Symbol sym, ACell value) throws ParseException {
+		
+		switch (sym.getName().toString()) {
+		case "Index": 
+			if (!(value instanceof AHashMap)) throw new ParseException(sym+" tag must be on a map");
+			Index<ABlobLike<?>,ACell> index= Index.create((AHashMap<ABlobLike<?>,ACell>)value);
+			if (index==null) throw new ParseException("Invalid Index keys");
+			return index;
+		}
+		return value;
+	}
+
 }
diff --git a/convex-core/src/main/java/convex/core/data/Index.java b/convex-core/src/main/java/convex/core/data/Index.java
@@ -836,7 +836,17 @@ public static <R extends AIndex<K, V>, K extends ABlobLike<?>, V extends ACell>
 		}
 		return (R) result;
 	}
-
-
+	
+	@SuppressWarnings("unchecked")
+	public static <R extends AIndex<K, V>, K extends ABlobLike<?>, V extends ACell> R create(AHashMap<K, V> map) {
+		Index<K,V> result=(Index<K, V>) EMPTY;
+		long n=map.count();
+		for (long i=0; i<n; i++) {
+			MapEntry<K,V> me=map.entryAt(i);
+			result=result.assoc(me.getKey(), me.getValue());
+			if (result==null) return null;
+		}
+		return (R) result;
+	}
 
 }
diff --git a/convex-core/src/main/java/convex/core/data/type/AType.java b/convex-core/src/main/java/convex/core/data/type/AType.java
@@ -1,6 +1,7 @@
 package convex.core.data.type;
 
 import convex.core.data.ACell;
+import convex.core.data.AString;
 
 /**
  * Abstract base class for CVM value types
@@ -43,4 +44,12 @@ public abstract class AType {
 	 * @return Java Class representing this Type
 	 */
 	public abstract Class<? extends ACell> getJavaClass();
+
+	/**
+	 * Gets the tag to be used for printing
+	 * @return Tag string, or null if no tag required
+	 */
+	public AString getTag() {
+		return null;
+	}
 }
diff --git a/convex-core/src/main/java/convex/core/data/type/IndexType.java b/convex-core/src/main/java/convex/core/data/type/IndexType.java
@@ -2,7 +2,9 @@
 
 import convex.core.data.ACell;
 import convex.core.data.AIndex;
+import convex.core.data.AString;
 import convex.core.data.Index;
+import convex.core.data.Strings;
 
 /**
  * Type that represents any CVM map
@@ -12,6 +14,8 @@ public class IndexType extends AStandardType<AIndex> {
 
 	public static final IndexType INSTANCE = new IndexType();
 	
+	private static final AString TAG=Strings.create("#Index");
+	
 	private IndexType() {
 		super(AIndex.class);
 	}
@@ -36,5 +40,10 @@ public AIndex implicitCast(ACell a) {
 		if (a instanceof Index) return (Index)a;
 		return null;
 	}
+	
+	@Override
+	public AString getTag() {
+		return TAG;
+	}
 
 }
diff --git a/convex-core/src/main/java/convex/core/lang/RecordFormat.java b/convex-core/src/main/java/convex/core/lang/RecordFormat.java
@@ -53,7 +53,7 @@ public Long indexFor(Keyword key) {
 	 * @param i Index of record key
 	 * @return Keyword at the specified index
 	 */
-	public Keyword getKey(int i) {
+	public Keyword getKey(long i) {
 		return keys.get(i);
 	}
 }
diff --git a/convex-core/src/main/java/convex/core/lang/reader/AntlrReader.java b/convex-core/src/main/java/convex/core/lang/reader/AntlrReader.java
@@ -18,6 +18,7 @@
 import convex.core.data.AList;
 import convex.core.data.Address;
 import convex.core.data.Blob;
+import convex.core.data.Cells;
 import convex.core.data.Keyword;
 import convex.core.data.List;
 import convex.core.data.Lists;
@@ -286,6 +287,36 @@ public void exitImplicitSymbol(ImplicitSymbolContext ctx) {
 			if (sym==null) throw new ParseException("Bad implicit symbol: "+s);
 			push( sym);
 		}
+		
+		@Override
+		public void enterTaggedForm(TaggedFormContext ctx) {
+			pushList();
+		}
+
+		@Override
+		public void exitTaggedForm(TaggedFormContext ctx) {
+			ArrayList<ACell> elements=popList();
+			if (elements.size()!=2) throw new ParseException("Tagged form tag and form but got:"+ elements);
+			Symbol sym=(Symbol) elements.get(0);
+			ACell value=elements.get(1);
+			
+			ACell result=Cells.createTagged(sym,value);
+			push(result);
+		}
+
+		@Override
+		public void enterTag(TagContext ctx) {
+			// Nothing to do
+		}
+
+		@Override
+		public void exitTag(TagContext ctx) {
+			String s=ctx.getText();
+			s=s.substring(1); // skip leading #
+			Symbol sym=Symbol.create(s);
+			if (sym==null) throw new ParseException("Bad tag: #"+s);
+			push( sym);
+		}
 
 		@Override
 		public void enterAddress(AddressContext ctx) {
@@ -478,6 +509,8 @@ public void exitPrimary(PrimaryContext ctx) {
 			// Nothing
 		}
 
+
+
 	}
 
 	public static ACell read(String s) {
diff --git a/convex-core/src/test/java/convex/core/data/IndexTest.java b/convex-core/src/test/java/convex/core/data/IndexTest.java
@@ -233,6 +233,11 @@ public void testIdentity() {
 		assertNotEquals(Index.create(bb, bl), Index.create(ba,bl)); // different entry key types
 		assertEquals(Index.create(bb, bl), Index.create(bl,bl)); // same entry key types
 	}
+	
+	@Test 
+	public void testPrint() {
+		assertEquals("#Index {}",Index.EMPTY.toString());
+	}
 
 	@Test
 	public void testSingleEntry() throws InvalidDataException {
@@ -442,6 +447,9 @@ private <K extends ABlobLike<?>, V extends ACell> void doIndexTests(Index<K, V>
 			assertTrue(e1.getKey().compareTo(e2.getKey().toBlob()) < 0);
 		}
 		
+		// TODO: should round trip when all child types do
+		// assertEquals(m,Reader.read(RT.print(m).toString()));
+		
 		assertEquals(Types.INDEX,m.getType());
 
 		CollectionsTest.doMapTests(m);
diff --git a/convex-core/src/test/java/convex/core/lang/ReaderTest.java b/convex-core/src/test/java/convex/core/lang/ReaderTest.java
@@ -16,6 +16,7 @@
 import convex.core.data.Address;
 import convex.core.data.Blob;
 import convex.core.data.Blobs;
+import convex.core.data.Index;
 import convex.core.data.Keyword;
 import convex.core.data.Keywords;
 import convex.core.data.Lists;
@@ -61,6 +62,9 @@ public void testKeywords() {
 		
 		assertEquals(Keyword.create("nil"), Reader.read(":nil"));
 		
+		// special case, since "/" is a valid name on its own
+		assertEquals(Keyword.create("/"), Reader.read(":/"));
+		
 		assertThrows(ParseException.class,()->Reader.read(":"));
 
 	}
@@ -364,6 +368,15 @@ public void doIdempotencyTest(ACell cell) {
 		assertEquals(s,RT.toString(Reader.read(s)));
 	}
 	
+	@Test public void testTagged() {
+		assertEquals(null,Reader.read("#foo nil"));
+		assertEquals(Index.EMPTY,Reader.read("#Index {}"));
+		assertEquals(Index.of(Blob.EMPTY,CVMLong.ONE),Reader.read("#Index {0x 1}"));
+		assertEquals(Index.of(Blob.fromHex("1234"),CVMLong.ONE,Blob.fromHex("12"),CVMLong.ZERO),Reader.read("#Index {0x12 0 0x1234 1}"));
+		assertParseException(()->Reader.read("#Index nil"));
+		assertParseException(()->Reader.read("#Index {true false}"));
+	}
+	
 	/**
 	 * Test cases that should read and print identically
 	 */

Original file line number	Diff line number	Diff line change
`@@ -836,7 +836,17 @@ public static <R extends AIndex<K, V>, K extends ABlobLike<?>, V extends ACell>`
`836`	`836`	`}`
`837`	`837`	`return (R) result;`
`838`	`838`	`}`
`839`		`-`
`840`		`-`
	`839`	`+`
	`840`	`+ @SuppressWarnings("unchecked")`
	`841`	`+ public static <R extends AIndex<K, V>, K extends ABlobLike<?>, V extends ACell> R create(AHashMap<K, V> map) {`
	`842`	`+ Index<K,V> result=(Index<K, V>) EMPTY;`
	`843`	`+ long n=map.count();`
	`844`	`+ for (long i=0; i<n; i++) {`
	`845`	`+ MapEntry<K,V> me=map.entryAt(i);`
	`846`	`+ result=result.assoc(me.getKey(), me.getValue());`
	`847`	`+ if (result==null) return null;`
	`848`	`+ }`
	`849`	`+ return (R) result;`
	`850`	`+ }`
`841`	`851`
`842`	`852`	`}`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public Long indexFor(Keyword key) {`
`53`	`53`	`* @param i Index of record key`
`54`	`54`	`* @return Keyword at the specified index`
`55`	`55`	`*/`
`56`		`- public Keyword getKey(int i) {`
	`56`	`+ public Keyword getKey(long i) {`
`57`	`57`	`return keys.get(i);`
`58`	`58`	`}`
`59`	`59`	`}`