1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# This script generates the opcode.json file with functionalSynopsis
# by Andres Cabrera June 2006-2010
# Licensed under the GPL licence version 3 or later
# modification for empty arg in command and links on opcodes by Francois Pinot February 2007
from __future__ import print_function
import os
import glob
import json
from xml.dom import minidom
# categories holds the list of valid categories for opcodes
from categories import categories
XO = False
opcodelist = []
outfilename = 'opcodes.json'
entries = []
for i in categories:
entries.append([])
manualfilename = 'manual.xml'
manual = open(manualfilename, 'r')
text = manual.read()
manual.close()
files = glob.glob('opcodes/*.xml')
files.extend(list(glob.glob('opcodes/*/*.xml')))
files.extend(list(glob.glob('vectorial/*.xml')))
files.extend(list(glob.glob('utility/*.xml')))
files.sort()
if 'opcodes/topXO.xml' in files:
files.remove('opcodes/topXO.xml')
headerText = text[0:text.find('<book id="index"')]
special_entries = {
'adds.xml': {'synopsis': 'a + b (no rate restriction)', 'opcodeName': '+'},
'dollar.xml': {'synopsis': '$NAME', 'opcodeName': '$NAME'},
'divides.xml': {'synopsis': 'a / b (no rate restriction)', 'opcodeName': '/'},
'modulus.xml': {'synopsis': 'a % b (no rate restriction)', 'opcodeName': '%'},
'multiplies.xml': {'synopsis': 'a * b (no rate restriction)', 'opcodeName': '*'},
'opbitor.xml': {'synopsis': 'a | b (bitwise OR)', 'opcodeName': '|'},
'opor.xml': {'synopsis': 'a || b (logical OR; not audio-rate)', 'opcodeName': '||'},
'raises.xml': {'synopsis': 'a ^ b (b not audio-rate)', 'opcodeName': '^'},
'substracts.xml': {'synopsis': 'a - b (no rate restriction)', 'opcodeName': '-'},
'ifdef.xml': {
'synopsis': '#ifdef NAME .... #else .... #end',
'opcodeName': '#ifdef'
},
'define.xml': {
'synopsis': '#define NAME # replacement text #, #define NAME(a b c) # replacement text #',
'opcodeName': '#define'
},
'include.xml': {'synopsis': '#include "filename"', 'opcodeName': '#include'},
'undef.xml': {'synopsis': '#undef NAME', 'opcodeName': '#undef'},
'0dbfs.xml': {'synopsis': '0dbfs = iarg', 'opcodeName': '0dbfs'}
}
# Structure to hold JSON data
json_data = {'opcodes': []}
# Function to clean and reformat the synopsis, stripping out <synopsis> tags
def clean_synopsis(synopsis_list):
synopsis_texts = []
opcode_name = None
for synopsis in synopsis_list:
tmp = synopsis.toxml()
# Handle both <opcodename> and <command> tags
if '<opcodename>' in tmp:
if not opcode_name:
opcode_name = tmp[tmp.find('<opcodename>') + 12:tmp.find('</opcodename>')]
tmp = tmp.replace('<opcodename>', '**').replace('</opcodename>', '**')
elif '<command>' in tmp:
if not opcode_name:
opcode_name = tmp[tmp.find('<command>') + 9:tmp.find('</command>')]
tmp = tmp.replace('<command>', '**').replace('</command>', '**')
# Strip the <synopsis> tags
tmp = tmp.replace('<synopsis>', '').replace('</synopsis>', '')
synopsis_texts.append(tmp)
# Join the cleaned synopsis with line breaks
return '\n'.join(synopsis_texts), opcode_name
# Function to create functional-style synopsis
def create_functional_synopsis(synopsis_text):
functional_texts = []
lines = synopsis_text.split('\n')
for line in lines:
if '**' in line:
parts = line.split(' ')
result_var = parts[0] # First part is the variable (e.g., ares)
opcode = None
# Check if there's an opcode after the variable
if len(parts) > 1 and '**' in parts[1]:
opcode = parts[1].replace('**', '') # Extract opcode name
params = ' '.join(parts[2:]) if len(parts) > 2 else '' # Join remaining parts as parameters
# Determine type based on first letter of result_var
if result_var.startswith('a'):
opcode_type = 'a'
elif result_var.startswith('k'):
opcode_type = 'k'
else:
opcode_type = 'unknown'
if opcode: # Only add if opcode is not None
# Reformat to functional style
functional_line = f"{result_var} = **{opcode}:{opcode_type}**({params})"
functional_texts.append(functional_line)
return '\n'.join(functional_texts)
# Process each opcode XML file
for i, filename in enumerate(files):
source = open(filename, 'r', encoding='utf-8')
entryText = source.read().replace("\xef\xbb\xbf", "")
newfile = headerText + '<book id="index" lang="en">' + entryText + '</book>'
newfile = newfile.replace("\r", "").strip() # Remove any trailing whitespace/newlines
source.close()
try:
xmldoc = minidom.parseString(newfile)
except Exception as e:
print(f"Error parsing XML from file {filename}: {e}")
continue # Skip this file and continue to the next one
xmldocId = xmldoc.documentElement.getAttribute('id')
# Some files need special treatment (adds, dollar, divides, etc.)
folder, base = os.path.split(filename)
entry = special_entries.get(base)
if entry is None:
synopsis = xmldoc.getElementsByTagName('synopsis')
cleaned_synopsis, opcode_name = clean_synopsis(synopsis)
if not opcode_name:
opcode_name = "" # Fallback in case no <opcodename> or <command> tag is found
functional_synopsis = create_functional_synopsis(cleaned_synopsis)
entry = {
'synopsis': cleaned_synopsis,
'opcodeName': opcode_name,
'functionalSynopsis': functional_synopsis
}
else:
# If using special entries, make sure to initialize functionalSynopsis
entry['functionalSynopsis'] = '' # Initialize to empty string
info = xmldoc.getElementsByTagName('refentryinfo')
if info and entry:
category = info[0].toxml()[21:-23]
else:
print(f"No refentryinfo tag for file {filename}")
category = "Miscellaneous"
if entry:
print(f"{filename} sent to Miscellaneous")
desc = xmldoc.getElementsByTagName('refpurpose')
description = ""
if desc and entry:
description = desc[0].firstChild.toxml().strip()
else:
print(f"No refpurpose tag for file {filename}")
match = False
for j, thiscategory in enumerate(categories):
if category == thiscategory:
entries[j].append([entry, description])
match = True
if not match:
print(f"{filename} ---- WARNING! No Category Match!")
# Build JSON structure
for i, category in enumerate(categories):
if not entries[i]:
print(f"No entries for category: {category} ...Skipping")
continue
category_entry = {'category': category, 'opcodes': []}
for entry in entries[i]:
entrydef, description = entry
opcode_entry = {
'description': description if description else '',
'synopsis': entrydef['synopsis'],
'opcodeName': entrydef['opcodeName'],
'functionalSynopsis': entrydef.get('functionalSynopsis', '') # Use .get() to avoid KeyError
}
category_entry['opcodes'].append(opcode_entry)
json_data['opcodes'].append(category_entry)
# Write JSON data to file
with open(outfilename, 'w', encoding='utf-8') as jsonfile:
json.dump(json_data, jsonfile, ensure_ascii=False, indent=4)
print("JSON data has been written to", outfilename)
|
