Skip to content

Commit

Permalink
deploy: aaacccb
Browse files Browse the repository at this point in the history
  • Loading branch information
@intoinside
intoinside committed Apr 29, 2024
1 parent ea33eeb commit 1874cfe
Show file tree
Hide file tree
Showing 21 changed files with 887 additions and 8 deletions.
220 changes: 220 additions & 0 deletions common-global_8asm.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>c128lib Base: common-global.asm File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="organization-icon-small.jpg"/></td>
<td id="projectalign">
<div id="projectname">c128lib Base
</div>
<div id="projectbrief">Base macros for C128</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('common-global_8asm.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">common-global.asm File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Common module.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a83e3c1a543120b67e330db3c1779656c" id="r_a83e3c1a543120b67e330db3c1779656c"><td class="memItemLeft" align="right" valign="top">macro&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a83e3c1a543120b67e330db3c1779656c">c128lib_BasicUpstart128</a> (sysAddress)</td></tr>
<tr class="memdesc:a83e3c1a543120b67e330db3c1779656c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro sets up a BASIC program for the Commodore 128. <br /></td></tr>
<tr class="separator:a83e3c1a543120b67e330db3c1779656c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60ea2a187d9be7d14287b5fc88b30400" id="r_a60ea2a187d9be7d14287b5fc88b30400"><td class="memItemLeft" align="right" valign="top">macro&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a60ea2a187d9be7d14287b5fc88b30400">c128lib_fbne</a> (label)</td></tr>
<tr class="memdesc:a60ea2a187d9be7d14287b5fc88b30400"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro provides a far branch if not equal (BNE) operation. <br /></td></tr>
<tr class="separator:a60ea2a187d9be7d14287b5fc88b30400"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae58c2d2ecaf1f626d4974a75b87f4b56" id="r_ae58c2d2ecaf1f626d4974a75b87f4b56"><td class="memItemLeft" align="right" valign="top">macro&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae58c2d2ecaf1f626d4974a75b87f4b56">c128lib_fbmi</a> (label)</td></tr>
<tr class="memdesc:ae58c2d2ecaf1f626d4974a75b87f4b56"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro provides a far branch if minus (BMI) operation. <br /></td></tr>
<tr class="separator:ae58c2d2ecaf1f626d4974a75b87f4b56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common module. </p>
<p>Simple macros for the Commodore 128.</p>
<dl class="section author"><dt>Author</dt><dd>Raffaele Intorcia <a href="#" onclick="location.href='mai'+'lto:'+'raf'+'fa'+'ele'+'.i'+'nto'+'rc'+'ia@'+'gm'+'ail'+'.c'+'om'; return false;">raffa<span class="obfuscator">.nosp@m.</span>ele.<span class="obfuscator">.nosp@m.</span>intor<span class="obfuscator">.nosp@m.</span>cia@<span class="obfuscator">.nosp@m.</span>gmail<span class="obfuscator">.nosp@m.</span>.com</a></dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>MIT License Copyright (c) 2024 c128lib - <a href="https://github.com/c128lib">https://github.com/c128lib</a></dd></dl>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
<dl class="section date"><dt>Date</dt><dd>2024 </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a83e3c1a543120b67e330db3c1779656c" name="a83e3c1a543120b67e330db3c1779656c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83e3c1a543120b67e330db3c1779656c">&#9670;&#160;</a></span>c128lib_BasicUpstart128()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">macro c128lib_BasicUpstart128 </td>
<td>(</td>
<td class="paramtype">sysAddress</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>This macro sets up a BASIC program for the Commodore 128. </p>
<p>The macro sets the program counter to $1c01, which is the start of the BASIC area in C128. It then writes a link address to the end of the BASIC program, a line number, a SYS token, and the address to SYS to in ASCII decimal, followed by a null byte. After that, it writes a zero word to signal the end of the BASIC program and sets the program counter to $1c0e.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">sysAddress</td><td>The address to which the BASIC program will SYS to start the machine code part.</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>

</div>
</div>
<a id="a60ea2a187d9be7d14287b5fc88b30400" name="a60ea2a187d9be7d14287b5fc88b30400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60ea2a187d9be7d14287b5fc88b30400">&#9670;&#160;</a></span>c128lib_fbne()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">macro c128lib_fbne </td>
<td>(</td>
<td class="paramtype">label</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>This macro provides a far branch if not equal (BNE) operation. </p>
<p>The 6502 processor's BNE instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BNE). This macro extends that range by using a combination of BNE, BEQ, and JMP instructions.</p>
<p>If the label is within the range of a normal BNE, it uses that. If not, it uses a BEQ to skip over a JMP instruction.; This works because BNE jumps if the zero flag is clear, and BEQ jumps if the zero flag is set - they are opposites. So if the BNE would not have jumped, the BEQ does, and the JMP is skipped. If the BNE would have jumped, the BEQ does not, and the JMP is executed, jumping to the label.;</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The label to jump to if the zero flag is not set.;</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>

</div>
</div>
<a id="ae58c2d2ecaf1f626d4974a75b87f4b56" name="ae58c2d2ecaf1f626d4974a75b87f4b56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae58c2d2ecaf1f626d4974a75b87f4b56">&#9670;&#160;</a></span>c128lib_fbmi()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">macro c128lib_fbmi </td>
<td>(</td>
<td class="paramtype">label</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>This macro provides a far branch if minus (BMI) operation. </p>
<p>The 6502 processor's BMI instruction can only jump a limited distance (from -128 to +127 bytes relative to the instruction following BMI). This macro extends that range by using a combination of BMI, BPL, BEQ, and JMP instructions.</p>
<p>If the label is within the range of a normal BMI, it uses that. If not, it uses a BPL and BEQ to skip over a JMP instruction.; This works because BMI jumps if the negative flag is set, and BPL jumps if the negative flag is clear - they are opposites. So if the BMI would not have jumped, the BPL and BEQ do, and the JMP is skipped. If the BMI would have jumped, the BPL and BEQ do not, and the JMP is executed, jumping to the label.;</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">label</td><td>The label to jump to if the negative flag is set.;</td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>0.1.0 </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="common-global_8asm.html">common-global.asm</a></li>
<li class="footer">Generated on Mon Apr 29 2024 20:34:49 for c128lib Base by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
6 changes: 6 additions & 0 deletions common-global_8asm.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var common_global_8asm =
[
[ "c128lib_BasicUpstart128", "common-global_8asm.html#a83e3c1a543120b67e330db3c1779656c", null ],
[ "c128lib_fbne", "common-global_8asm.html#a60ea2a187d9be7d14287b5fc88b30400", null ],
[ "c128lib_fbmi", "common-global_8asm.html#ae58c2d2ecaf1f626d4974a75b87f4b56", null ]
];
Loading

0 comments on commit 1874cfe

Please sign in to comment.