Commit fce5556d authored by Neil Turton's avatar Neil Turton
Browse files

Import from cleaned 360 CD

parents
hdr/** gitlab-language=armasm linguist-language=armasm linguist-detectable=true
s/** gitlab-language=armasm linguist-language=armasm linguist-detectable=true
> net#arf:$.a500.RiscOS+.doc.ResourceFS
Author: Neil Raine
Status: Draft proposal, not agreed yet
History:
6-Feb-90 0.01 First draft.
20-Feb-90 0.02 Aasm164 included
22-Feb-90 0.03 Name changed from DeskFS to ResourceFS
Issues (ignore on first reading)
------
There is work still to be done on getting C modules to include files.
Overview
--------
This document describes the interface to the ResourceFS module, which
provides the hooks necessary for modules to include files in the Resources:
filing system.
This facility is useful because it allows the resource files associated with
a particular module to be included in the same file as the binary image,
which helps with release control.
It also has an important application for podule modules, since it allows
them to *IconSprites a sprite file which they put into Resources:. This is
important as there is no other way to introduce a sprite into the Wimp's
free pool other than from a file.
Another application is for certain resource files to be replaced on a
selective basis, which is an additional technique to the path mechanism
already in use (eg. Wimp$Path can be set up to reference a resource
directory).
Directory structure
-------------------
In order to avoid possible name clashes, it is important that a well-defined
directory structure is adhered to by all concerned. This is:
$.Apps.!<appname> ; the ROM-resident applications
$.Fonts ; the ROM-resident fonts
$.Resources.<modulename> ; resources for ADFSFiler etc.
$.Resources.<appname> ; resources for PrinterDM etc.
$.ThirdParty.<appname> ; resources for 3rd parties
where <appname> is the name of the application concerned, without the "!" on
the front (eg. Draw, Paint, Edit).
The above all indicate directories, which normally contain files called
"!Sprites", "Templates", "Messages" and so on.
Where third party software is involved, the actual <appname> used must be
registered with Acorn, to avoid clashes.
Software interface
------------------
In order to register a group of files with ResourceFS, a module must have
the files included in their image, with appopriate header information, and
then call SWIs to register and de-register this area as appropriate.
SWI ResourceFS_RegisterFiles
In: R0 -> area of memory containing files (see below for format)
This SWI should be called when the module is initialised.
ResourceFS will link the file(s) into its structure, and then issue
a Service_ResourceFSStarted (not to be confused with
Service_ResourceFSStarting - see below), which tells any programs
relying on ResourceFS files that the structure has changed. The
Wimp responds to this service call by looking for its default sprite
pool again.
SWI ResourceFS_DeregisterFiles
In: R0 -> area of memory containing files
This SWI should be called when the area of memory containing the
files is about to be deallocated (eg. when the module containing
them is killed).
Note that it is not necessary to call this SWI on receipt of a
Service_ResourceFSDying, since the ResourceFS module 'loses' all
references to ResourceFS files when it dies anyway.
Service_ResourceFSStarting (&60)
In: R2 -> code address to call
R3 = workspace pointer for ResourceFS module
Out: all registers preserved (do not claim the service)
When the ResourceFS module is reloaded or re-initialised, it issues
this service call so that modules that provide ResourceFS files can
put them back into the structure.
Unfortunately the ResourceFS module is not linked into the module
chain at this point, so it is not possible to call
ResourceFS_RegisterFiles. Instead, the application should execute
the following code:
STMFD SP!, {R0, LR}
ADR R0, ResourceFSfiles ; R0 -> ResourceFS file structure
MOV LR, PC ; LR -> return address
MOV PC, R2 ; call ResourceFS routine
LDMFD SP!, {R0, PC}^
Note that the value of R3 passed in the service call must be given
to the ResourceFS routine intact, so it can find its workspace.
This call is subtly different from SWI ResourceFS_RegisterFiles, in
that it will not cause a Service_ResourceFSStarted to be issued.
This is because the ResourceFS module waits until all modules have
received the Service_ResourceFSStarting before issuing a
Service_ResourceFSStarted to let the "clients" of Resources: know
about it.
The format of the (word-aligned) file data is as follows:
Offset Size Meaning
------ ---- -------
0 4 offset from here to the next file (contiguous),
or 0 => end of list (no data follows)
4 4 load address of file )
8 4 exec address of file ) as returned by OS_File (5)
12 4 size of file )
16 4 attributes of file )
20 n full filename, excluding "$.", terminated by 0
20+n 0..3 padded with 0s until word-aligned
4 size of file + 4
s file data
0..3 padded with 0s until word-aligned
followed by more data in the same format
(last entry must be a single 0 word)
The file data must be contiguous - if this is not possible, then
ResourceFS_RegisterFiles should be called once for each of the areas to be
used (and an equivalent set of ResourceFS_DeRegisterFiles's later on). Note
that each area must be terminated by a single word containing 0.
There are no directory objects, since the directory structure can be
determined from the full filenames supplied.
Note that where name clashes occur, the first occurrence of the filename in
the most recently registered area will be used.
Constructing the modules
------------------------
In net#arf:$.a500.Aasm164, you will find two files:
Aasm
ObjAsm
which are the C versions of Aasm 1.64 and ObjAsm 1.64 respectively. They
require the C shared library (with or without RISC_OSLib extensions) to run.
Version 1.64 has the following additional features:
BIN "<filename>" ; include binary file in output
DCD :FLOAD:"<filename>" ; get load address of file
DCD :FEXEC:"<filename>" ; get exec address of file
DCD :FSIZE:"<filename>" ; get size (length) of file
DCD :FATTR:"<filename>" ; get attributes of file
These are used in net#arf:$.a500.Hdr.ResourceFS in a macro called
"ResourceFile", which takes two arguments: the name of the file to include,
and the name it will have under Resources:. You can put a series of calls
to this macro in sequence, followed by " DCD 0" to terminate the list, eg:
ResourceFSfiles
ResourceFile Sources.Messages, Resources.MyProg.Messages
ResourceFile Sources.Templates, Resources.MyProg.Templates
DCD 0
# ResourceFS *Help Messages file
ResourceFS:*ResourceFS selects the ResourceFS filing system.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Copyright 1996 Acorn Computers Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Makefile for ResourceFS
#
# ***********************************
# *** C h a n g e L i s t ***
# ***********************************
# Date Name Description
# ---- ---- -----------
# 25-May-94 AMcC Created.
#
#
# Paths
#
EXP_HDR = <export$dir>
#
# Generic options:
#
MKDIR = cdir
AS = aasm
CP = copy
RM = remove
CCFLAGS = -c -depend !Depend -IC:
ASFLAGS = -depend !Depend -Stamp -quit -module -To $@ -From
CPFLAGS = ~cfr~v
#
# Program specific options:
#
COMPONENT = ResourceFS
SOURCE = s.ResourceFS
TARGET = rm.ResourceFS
EXPORTS = ${EXP_HDR}.${COMPONENT}
#
# Generic rules:
#
rom: ${TARGET}
@echo ${COMPONENT}: rom module built
export: ${EXPORTS}
@echo ${COMPONENT}: export complete
install_rom: ${TARGET}
${CP} ${TARGET} ${INSTDIR}.${COMPONENT} ${CPFLAGS}
@echo ${COMPONENT}: rom module installed
clean:
${RM} ${TARGET}
@echo ${COMPONENT}: cleaned
resources:
${MKDIR} ${RESDIR}.${COMPONENT}
${CP} Resources.${LOCALE}.Messages ${RESDIR}.${COMPONENT}.Messages ${CPFLAGS}
@echo ${COMPONENT}: resource files copied
${TARGET}: ${SOURCE}
${AS} ${ASFLAGS} ${SOURCE}
${EXP_HDR}.${COMPONENT}: hdr.${COMPONENT}
${CP} hdr.${COMPONENT} $@ ${CPFLAGS}
# Dynamic dependencies:
| Copyright 1996 Acorn Computers Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine clean
| Copyright 1996 Acorn Computers Ltd
|
| Licensed under the Apache License, Version 2.0 (the "License");
| you may not use this file except in compliance with the License.
| You may obtain a copy of the License at
|
| http://www.apache.org/licenses/LICENSE-2.0
|
| Unless required by applicable law or agreed to in writing, software
| distributed under the License is distributed on an "AS IS" BASIS,
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| See the License for the specific language governing permissions and
| limitations under the License.
|
Dir <Obey$Dir>
amu_machine rom
# ResourceFS Syntax Messages file
ResourceFS:Syntax: *ResourceFS
; > Version
GBLA Version
GBLS VString
GBLS Date
Version SETA 015
VString SETS "0.15"
Date SETS "28 Oct 1994"
END
; Copyright 1996 Acorn Computers Ltd
;
; Licensed under the Apache License, Version 2.0 (the "License");
; you may not use this file except in compliance with the License.
; You may obtain a copy of the License at
;
; http://www.apache.org/licenses/LICENSE-2.0
;
; Unless required by applicable law or agreed to in writing, software
; distributed under the License is distributed on an "AS IS" BASIS,
; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
; See the License for the specific language governing permissions and
; limitations under the License.
;
SUBT Exported ResourceFS constants
OldOpt SETA {OPT}
OPT OptNoList+OptNoP1List
; ***********************************
; *** C h a n g e L i s t ***
; ***********************************
; Date Name Description
; ---- ---- -----------
; 13-Feb-90 NDR File created
; 22-Feb-90 NDR Name changed from DeskFS to ResourceFS
; 20-Jun-90 NDR Changed macro so attributes are always 3
; 17-May-94 AMcC Changed to using the preferred SWI base and name symbols
SWIClass SETS ResourceFSSWI_Name
^ ResourceFSSWI_Base
AddSWI RegisterFiles ; &41B40
AddSWI DeregisterFiles ; &41B41
MACRO
$Start ResourceFile $InFile, $OutFile
$Start DCD %FT60 - . ; Offset from here to the next file
DCD :FLOAD:"$InFile" ; Load address of file
DCD :FEXEC:"$InFile" ; Exec address of file
DCD :FSIZE:"$InFile" ; The length of the file
DCD 3 ; Access bits (always WR/)
DCB "$OutFile",0 ; The ResourceFS filename
ALIGN
DCD %FT40-%FT20+4 ; The file length plus four
20
BIN $InFile ; The file itself
40
ALIGN
60
MEND
OPT OldOpt
END
*
!.gitignore
; Copyright 1996 Acorn Computers Ltd
;
; Licensed under the Apache License, Version 2.0 (the "License");
; you may not use this file except in compliance with the License.
; You may obtain a copy of the License at
;
; http://www.apache.org/licenses/LICENSE-2.0
;
; Unless required by applicable law or agreed to in writing, software
; distributed under the License is distributed on an "AS IS" BASIS,
; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
; See the License for the specific language governing permissions and
; limitations under the License.
;
; Message file handling code.
; OSS Translate an error block, with one substituted parameter.
; In: r0 -> Error block containing the token
; r1 -> %0 parameter to substitute
; Out: r0 -> Translated error block or another error (token no found etc.)
; All other registers preserved, V always set, other flags undefined
copy_error_one ENTRY "r2-r7"
BL open_message_file ; Ensure file is open
EXIT VS ; Return the error
MOV r4, r1 ; Move input %0
ADR r1, message_file_block ; Messages file handle
MOV r2, #0 ; Use MessageTrans buffer
MOV r5, #0 ; No %1
MOV r6, #0 ; No %2
MOV r7, #0 ; No %3
SWI XMessageTrans_ErrorLookup ; Always sets the V flag
MOV r1, r4 ; Preserve input r1
EXIT
message_filename
DCB "Resources:$.Resources.ResourceFS.Messages", 0
ALIGN
; OSS Open the messages file if it is closed.
open_message_file ENTRY "r0-r2"
LDR r1 , message_file_open
TEQ r1, #0 ; Check the open flag
EXIT NE ; Return - it is open
ADR r0, message_file_block ; Messages file handle
ADR r1, message_filename ; Messages filename
MOV r2, #0 ; Buffer in RMA/access direct
SWI XMessageTrans_OpenFile
STRVS r0, [sp] ; Return the error
EXIT VS
MOV r1, #1
STR r1, message_file_open ; Flag the file as open
EXIT
END
This diff is collapsed.