From ebc519ee0ed92a06a7944a7f201416ecfb87b830 Mon Sep 17 00:00:00 2001
From: "ol.sc" <ol.sc@b7a2c559-68d2-44c3-8de9-860c34a00d81>
Date: Tue, 3 Jan 2012 21:55:34 +0000
Subject: [PATCH] Added a sample demonstrating how to create a VLIR overlay
 program.

git-svn-id: svn://svn.cc65.org/cc65/trunk@5376 b7a2c559-68d2-44c3-8de9-860c34a00d81
---
 samples/geos/overlay-demo.c      | 109 +++++++++++++++++++++++++++++++
 samples/geos/overlay-demores.grc |  11 ++++
 2 files changed, 120 insertions(+)
 create mode 100644 samples/geos/overlay-demo.c
 create mode 100644 samples/geos/overlay-demores.grc

diff --git a/samples/geos/overlay-demo.c b/samples/geos/overlay-demo.c
new file mode 100644
index 000000000..622c06442
--- /dev/null
+++ b/samples/geos/overlay-demo.c
@@ -0,0 +1,109 @@
+/*
+ * Minimalistic GEOSLib overlay demo program
+ *
+ * 2012-01-01, Oliver Schmidt (ol.sc@web.de)
+ *
+ */
+
+
+#include <stdio.h>
+#include <geos.h>
+#include "overlay-demores.h"
+
+
+/* Functions resident in an overlay can call back functions resident in the
+ * main program at any time without any precautions. The function show() is
+ * an example for such a function resident in the main program.
+ */
+void show(char *name)
+{
+    char line1[40];
+
+    sprintf(line1, CBOLDON "Overlay Demo - Overlay %s" CPLAINTEXT, name);
+    DlgBoxOk(line1,
+             "Click OK to return to Main.");
+}
+
+/* In a real-world overlay program one would probably not use a #pragma but
+ * rather place the all the code of certain souce files into the overlay by
+ * compiling them with --code-name OVERLAY1.
+ */
+#pragma code-name(push, "OVERLAY1");
+
+void foo(void)
+{
+    /* Functions resident in an overlay can access all program variables and
+     * constants at any time without any precautions because those are never
+     * placed in overlays. The string constant "One" is an example for such 
+     * a constant resident in the main program.
+     */
+    show("One");
+}
+
+#pragma code-name(pop);
+
+
+#pragma code-name(push, "OVERLAY2");
+
+void bar(void)
+{
+    show("Two");
+}
+
+#pragma code-name(pop);
+
+
+#pragma code-name(push, "OVERLAY3");
+
+void foobar (void)
+{
+    show("Three");
+}
+
+#pragma code-name(pop);
+
+
+void main(int /*argc*/, char *argv[])
+{
+    OpenRecordFile(argv[0]);
+
+    DlgBoxOk(CBOLDON "Overlay Demo - Main" CPLAINTEXT,
+             "Click OK to call Overlay One.");
+
+    PointRecord(1);
+
+    /* The macro definitions OVERLAY_ADDR and OVERLAY_SIZE were generated in
+     * overlay-demores.h by grc65. They contain the overlay area address and
+     * size specific to a certain program.
+     */
+    ReadRecord(OVERLAY_ADDR, OVERLAY_SIZE);
+
+    /* The linker makes sure that the call to foo() ends up at the right mem
+     * addr. However it's up to user to make sure that the - right - overlay
+     * is actually loaded before making the the call.
+     */
+    foo();
+
+    DlgBoxOk(CBOLDON "Overlay Demo - Main" CPLAINTEXT,
+             "Click OK to call Overlay Two.");
+
+    PointRecord(2);
+
+    /* Replacing one overlay with another one can only happen from the main
+     * program. This implies that an overlay can never load another overlay.
+     */
+    ReadRecord(OVERLAY_ADDR, OVERLAY_SIZE);
+
+    bar();
+
+    DlgBoxOk(CBOLDON "Overlay Demo - Main" CPLAINTEXT,
+             "Click OK to call Overlay Three.");
+
+    PointRecord(3);
+
+    ReadRecord(OVERLAY_ADDR, OVERLAY_SIZE);
+
+    foobar();
+
+    CloseRecordFile();
+}
diff --git a/samples/geos/overlay-demores.grc b/samples/geos/overlay-demores.grc
new file mode 100644
index 000000000..6bb71e24d
--- /dev/null
+++ b/samples/geos/overlay-demores.grc
@@ -0,0 +1,11 @@
+HEADER APPLICATION "Overlay Demo" "Overlay Demo" "V1.0" {
+    author    "Oliver Schmidt"
+    info      "This is a minimalistic cc65 GEOSLib overlay demo program written in C."
+    date      12 01 01 12 00
+    structure VLIR
+}
+
+MEMORY {
+    overlaysize 0x1000
+    overlaynums 0 1 2 3
+}