From: Lauri Kasanen <cand@gmx.com>
Date: Mon, 1 May 2017 16:50:01 +0000 (+0300)
Subject: Document pragma trampoline
X-Git-Tag: V2.17~142^2~12
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=82e62209d696dcb082bd67e227dd5fe30256c776;p=cc65

Document pragma trampoline
---

diff --git a/doc/cc65.sgml b/doc/cc65.sgml
index 24b37133e..99ddfc82d 100644
--- a/doc/cc65.sgml
+++ b/doc/cc65.sgml
@@ -1209,6 +1209,31 @@ parameter with the <tt/#pragma/.
   The <tt/#pragma/ understands the push and pop parameters as explained above.
 
 
+<sect1><tt>#pragma trampoline (&lt;push&rt;, &lt;name&gt;, &lt;value&gt;)</tt><label id="pragma-trampoline"><p>
+
+  This pragma sets a trampoline for functions. The name is either
+  a function returning void and taking no parameters, or the address
+  of an array in memory (for a RAM trampoline). The value is an
+  8-bit number that's set to tmp4.
+
+  The address of the function is passed in ptr4.
+
+  This is useful for example with banked memory, to automatically
+  switch banks to where this function resides, and then restore
+  the bank when it returns.
+
+  The <tt/#pragma/ requires the push and pop parameters as explained above.
+
+  Example:
+  <tscreen><verb>
+	void mytrampoline(void);
+
+        #pragma trampoline (push, mytrampoline, 0)
+        void somefunc(void);
+        #pragma trampoline (pop)
+  </verb></tscreen>
+
+
 <sect1><tt>#pragma warn (name, [push,] on|off)</tt><label id="pragma-warn"><p>
 
   Switch compiler warnings on or off. "name" is the name of a warning (see the