summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Schleef <ds@schleef.org>2009-05-28 15:10:27 -0700
committerDavid Schleef <ds@schleef.org>2009-05-28 15:10:27 -0700
commit00bd494c150b88ec7889a1e77aaecd1557e3dc30 (patch)
tree6814dd34327503a3d61577c257623a3af030d878 /doc
parentda569a4989bb0c20ea4c21910186733037d83149 (diff)
downloadorc-00bd494c150b88ec7889a1e77aaecd1557e3dc30.tar.gz
doc: add doc files
Diffstat (limited to 'doc')
-rw-r--r--doc/orc-docs.sgml19
-rw-r--r--doc/orc-overrides.txt0
-rw-r--r--doc/orc-sections.txt318
-rw-r--r--doc/orc.types0
4 files changed, 337 insertions, 0 deletions
diff --git a/doc/orc-docs.sgml b/doc/orc-docs.sgml
new file mode 100644
index 0000000..7b0ce3c
--- /dev/null
+++ b/doc/orc-docs.sgml
@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>orc Reference Manual</title>
+ <releaseinfo>
+ for orc [VERSION]
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://[SERVER]/orc/index.html">http://[SERVER]/orc/</ulink>.
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>[Insert title here]</title>
+ <xi:include href="xml/orcprogram.xml"/>
+ <xi:include href="xml/x86.xml"/>
+ </chapter>
+</book>
diff --git a/doc/orc-overrides.txt b/doc/orc-overrides.txt
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/orc-overrides.txt
diff --git a/doc/orc-sections.txt b/doc/orc-sections.txt
new file mode 100644
index 0000000..6527a7c
--- /dev/null
+++ b/doc/orc-sections.txt
@@ -0,0 +1,318 @@
+<SECTION>
+<FILE>orc</FILE>
+orc_init
+</SECTION>
+
+<SECTION>
+<FILE>orcprogram</FILE>
+OrcProgram
+ORC_N_CONSTANTS
+ORC_N_RULE_SETS
+ORC_N_TARGETS
+ORC_PROGRAM_ERROR
+orc_program_new
+orc_program_new_dss
+orc_program_append
+orc_program_append_str
+orc_program_compile
+orc_program_x86_init
+orc_program_powerpc_init
+orc_program_assemble_x86
+orc_program_assemble_powerpc
+orc_program_assemble_c
+orc_program_free
+orc_program_find_var_by_name
+orc_program_add_temporary
+orc_program_dup_temporary
+orc_program_add_source
+orc_program_add_destination
+orc_program_add_constant
+orc_program_x86_reset_alloc
+orc_program_powerpc_reset_alloc
+orc_program_allocate_register
+orc_program_x86_allocate_register
+orc_program_powerpc_allocate_register
+orc_program_x86_register_rules
+orc_program_allocate_codemem
+orc_program_dump_code
+orc_program_add_accumulator
+orc_program_add_parameter
+orc_program_append_ds
+orc_program_append_ds_str
+orc_program_compile_for_target
+orc_program_compile_full
+orc_program_dump_asm
+orc_program_get_asm_code
+orc_program_get_max_var_size
+orc_program_get_name
+orc_program_new_as
+orc_program_new_ass
+orc_program_new_ds
+orc_program_set_name
+</SECTION>
+
+<SECTION>
+<FILE>orcutils</FILE>
+orc_bool
+ORC_ASSERT
+ORC_BEGIN_DECLS
+ORC_CLAMP
+ORC_END_DECLS
+ORC_EXPORT
+ORC_GNUC_PREREQ
+ORC_GNU_PRINTF
+ORC_INTERNAL
+ORC_PTR_TO_INT
+ORC_READ_UINT32_LE
+ORC_WRITE_UINT32_LE
+</SECTION>
+
+<SECTION>
+<FILE>misc</FILE>
+OrcType
+OrcVariable
+OrcArgument
+OrcInstruction
+OrcRegister
+OrcRule
+OrcFixup
+OrcRuleEmitFunc
+ORC_N_REGS
+ORC_N_INSNS
+ORC_N_VARIABLES
+ORC_N_REGISTERS
+ORC_N_FIXUPS
+ORC_N_LABELS
+ORC_GP_REG_BASE
+ORC_VEC1_REG_BASE
+ORC_VEC2_REG_BASE
+ORC_REGCLASS_GP
+ORC_STRUCT_OFFSET
+OrcVarType
+orc_type_get
+orc_type_register
+orc_variable_get_size
+orc_x86_init
+orc_powerpc_init
+orc_arm_init
+orc_c_init
+orc_parse
+</SECTION>
+
+<SECTION>
+<FILE>orcdebug</FILE>
+OrcDebugLevel
+OrcDebugPrintFunc
+ORC_DEBUG_PRINT
+ORC_ERROR
+ORC_WARNING
+ORC_INFO
+ORC_DEBUG
+ORC_LOG
+orc_debug_get_level
+orc_debug_print
+orc_debug_set_level
+orc_debug_set_print_function
+</SECTION>
+
+<SECTION>
+<FILE>orccompiler</FILE>
+OrcCompileResult
+OrcCompiler
+ORC_COMPILER_ERROR
+ORC_COMPILE_RESULT_IS_FATAL
+ORC_COMPILE_RESULT_IS_SUCCESSFUL
+ORC_ASM_CODE
+ORC_ENABLE_ASM_CODE
+orc_compiler_allocate_codemem
+orc_compiler_append_code
+orc_compiler_get_dest
+orc_compiler_label_new
+</SECTION>
+
+<SECTION>
+<FILE>orcopcode</FILE>
+OrcOpcode
+OrcOpcodeEmulateFunc
+OrcOpcodeExecutor
+OrcOpcodeSet
+OrcRuleSet
+OrcStaticOpcode
+OrcTarget
+ORC_OPCODE_N_ARGS
+ORC_OPCODE_N_RULES
+ORC_STATIC_OPCODE_ACCUMULATOR
+ORC_STATIC_OPCODE_N_DEST
+ORC_STATIC_OPCODE_N_SRC
+orc_opcode_find_by_name
+orc_opcode_init
+orc_opcode_register_static
+orc_opcode_set_find_by_name
+orc_opcode_set_get
+orc_rule_set_new
+orc_target_get_asm_preamble
+orc_target_get_by_name
+orc_target_get_default
+orc_target_get_default_flags
+orc_target_get_name
+orc_target_get_rule
+orc_target_register
+</SECTION>
+
+<SECTION>
+<FILE>orcexecutor</FILE>
+OrcExecutor
+orc_executor_new
+orc_executor_free
+orc_executor_set_array
+orc_executor_set_array_str
+orc_executor_set_n
+orc_executor_emulate
+orc_executor_run
+orc_executor_get_accumulator
+orc_executor_get_accumulator_str
+orc_executor_set_param
+orc_executor_set_param_str
+orc_executor_set_program
+
+</SECTION>
+
+<SECTION>
+<FILE>orcrule</FILE>
+orc_rule_register
+</SECTION>
+
+<SECTION>
+<FILE>orcx86</FILE>
+orc_x86_emit_add_imm_memoffset
+orc_x86_emit_add_imm_reg
+orc_x86_emit_add_reg_memoffset
+orc_x86_emit_align
+orc_x86_emit_and_imm_memoffset
+orc_x86_emit_and_imm_reg
+orc_x86_emit_cmp_imm_memoffset
+orc_x86_emit_cmp_reg_memoffset
+orc_x86_emit_dec_memoffset
+orc_x86_emit_emms
+orc_x86_emit_epilogue
+orc_x86_emit_je
+orc_x86_emit_jle
+orc_x86_emit_jmp
+orc_x86_emit_jne
+orc_x86_emit_label
+orc_x86_emit_modrm_memoffset
+orc_x86_emit_modrm_reg
+orc_x86_emit_mov_imm_reg
+orc_x86_emit_mov_memoffset_mmx
+orc_x86_emit_mov_memoffset_reg
+orc_x86_emit_mov_memoffset_sse
+orc_x86_emit_mov_mmx_memoffset
+orc_x86_emit_mov_mmx_reg
+orc_x86_emit_mov_mmx_reg_reg
+orc_x86_emit_mov_reg_memoffset
+orc_x86_emit_mov_reg_mmx
+orc_x86_emit_mov_reg_reg
+orc_x86_emit_mov_reg_sse
+orc_x86_emit_mov_sse_memoffset
+orc_x86_emit_mov_sse_reg
+orc_x86_emit_mov_sse_reg_reg
+orc_x86_emit_pop
+orc_x86_emit_prologue
+orc_x86_emit_push
+orc_x86_emit_ret
+orc_x86_emit_rex
+orc_x86_emit_sar_imm_reg
+orc_x86_emit_sub_memoffset_reg
+orc_x86_emit_sub_reg_reg
+orc_x86_emit_test_reg_reg
+orc_x86_get_regname
+orc_x86_get_regname_16
+orc_x86_get_regname_64
+orc_x86_get_regname_mmx
+orc_x86_get_regname_ptr
+orc_x86_get_regname_sse
+orc_x86_get_regnum
+</SECTION>
+
+<SECTION>
+<FILE>orcsse</FILE>
+ORC_SSE_SHUF
+orc_sse_emit_0f
+orc_sse_emit_660f
+orc_sse_emit_f20f
+orc_sse_emit_f30f
+orc_sse_emit_loadib
+orc_sse_emit_loadil
+orc_sse_emit_loadiw
+orc_sse_emit_loadpb
+orc_sse_emit_loadpl
+orc_sse_emit_loadpq
+orc_sse_emit_loadpw
+orc_sse_emit_pshufd
+orc_sse_emit_pshuflw
+orc_sse_emit_shiftimm
+orc_sse_get_cpu_flags
+orc_sse_init
+</SECTION>
+
+<SECTION>
+<FILE>orcmmx</FILE>
+ORC_MMX_SHUF
+orc_mmx_emit_0f
+orc_mmx_emit_660f
+orc_mmx_emit_f20f
+orc_mmx_emit_f30f
+orc_mmx_emit_loadib
+orc_mmx_emit_loadil
+orc_mmx_emit_loadiw
+orc_mmx_emit_loadpb
+orc_mmx_emit_loadpl
+orc_mmx_emit_loadpq
+orc_mmx_emit_loadpw
+orc_mmx_emit_pshufw
+orc_mmx_emit_shiftimm
+orc_mmx_get_cpu_flags
+orc_mmx_init
+</SECTION>
+
+<SECTION>
+<FILE>orcarm</FILE>
+ORC_ARM_A1
+ORC_ARM_A2
+ORC_ARM_A3
+ORC_ARM_A4
+ORC_ARM_IP
+ORC_ARM_LR
+ORC_ARM_PC
+ORC_ARM_R0
+ORC_ARM_SB
+ORC_ARM_SP
+ORC_ARM_V1
+ORC_ARM_V2
+ORC_ARM_V3
+ORC_ARM_V4
+ORC_ARM_V5
+ORC_ARM_V6
+ORC_ARM_V7
+ORC_ARM_V8
+orc_arm_do_fixups
+orc_arm_emit
+orc_arm_emit_add
+orc_arm_emit_add_imm
+orc_arm_emit_branch
+orc_arm_emit_bx_lr
+orc_arm_emit_cmp_imm
+orc_arm_emit_dp_reg
+orc_arm_emit_label
+orc_arm_emit_load_reg
+orc_arm_emit_loadimm
+orc_arm_emit_mov
+orc_arm_emit_pop
+orc_arm_emit_push
+orc_arm_emit_sub
+orc_arm_emit_sub_imm
+orc_arm_loadw
+orc_arm_reg_name
+orc_arm_storew
+</SECTION>
+
diff --git a/doc/orc.types b/doc/orc.types
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/doc/orc.types