Skip to content

Commit cf43ca1

Browse files
fnueckefnuecke
committedJun 9, 2016
Added computer.getProgramLocations and IMC message to populate the returned table.
·
v1.8.0-snapshot-202209171.7.10-forge/v1.8.0-snapshot-20220917
1 parent 2874f47 commit cf43ca1

File tree

6 files changed

+108
-13
lines changed

6 files changed

+108
-13
lines changed
 

‎src/main/java/li/cil/oc/api/IMC.java

+51-11
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import net.minecraft.item.ItemStack;
55
import net.minecraft.nbt.NBTTagCompound;
66
import net.minecraft.nbt.NBTTagList;
7+
import net.minecraft.nbt.NBTTagString;
78
import org.apache.commons.lang3.tuple.Pair;
89

910
/**
@@ -20,6 +21,7 @@
2021
* copy this class while keeping the package name, to avoid conflicts if this
2122
* class gets updated.
2223
*/
24+
@SuppressWarnings("unused")
2325
public final class IMC {
2426
/**
2527
* Register a callback that is used as a filter for assembler templates.
@@ -37,7 +39,7 @@ public final class IMC {
3739
*
3840
* @param callback the callback to register as a filtering method.
3941
*/
40-
public static void registerAssemblerFilter(String callback) {
42+
public static void registerAssemblerFilter(final String callback) {
4143
FMLInterModComms.sendMessage(MOD_ID, "registerAssemblerFilter", callback);
4244
}
4345

@@ -98,7 +100,7 @@ public static void registerAssemblerFilter(String callback) {
98100
* with only two card slots will pass <tt>null</tt>
99101
* for the third component slot. Up to nine.
100102
*/
101-
public static void registerAssemblerTemplate(String name, String select, String validate, String assemble, Class host, int[] containerTiers, int[] upgradeTiers, Iterable<Pair<String, Integer>> componentSlots) {
103+
public static void registerAssemblerTemplate(final String name, final String select, final String validate, final String assemble, final Class host, final int[] containerTiers, final int[] upgradeTiers, final Iterable<Pair<String, Integer>> componentSlots) {
102104
final NBTTagCompound nbt = new NBTTagCompound();
103105
if (name != null) {
104106
nbt.setString("name", name);
@@ -187,7 +189,7 @@ public static void registerAssemblerTemplate(String name, String select, String
187189
* @param disassemble callback used to apply a template and extract
188190
* ingredients from an item.
189191
*/
190-
public static void registerDisassemblerTemplate(String name, String select, String disassemble) {
192+
public static void registerDisassemblerTemplate(final String name, final String select, final String disassemble) {
191193
final NBTTagCompound nbt = new NBTTagCompound();
192194
if (name != null) {
193195
nbt.setString("name", name);
@@ -218,7 +220,7 @@ public static void registerDisassemblerTemplate(String name, String select, Stri
218220
*
219221
* @param callback the callback to register as a durability provider.
220222
*/
221-
public static void registerToolDurabilityProvider(String callback) {
223+
public static void registerToolDurabilityProvider(final String callback) {
222224
FMLInterModComms.sendMessage(MOD_ID, "registerToolDurabilityProvider", callback);
223225
}
224226

@@ -234,15 +236,15 @@ public static void registerToolDurabilityProvider(String callback) {
234236
* <p/>
235237
* Signature of callbacks must be:
236238
* <pre>
237-
* boolean callback(EntityPlayer player, int x, int y, int z, boolean changeDurability)
239+
* boolean callback(EntityPlayer player, BlockPos pos, boolean changeDurability)
238240
* </pre>
239241
* <p/>
240242
* Callbacks must be declared as <tt>packagePath.className.methodName</tt>.
241243
* For example: <tt>com.example.Integration.callbackMethod</tt>.
242244
*
243245
* @param callback the callback to register as a wrench tool handler.
244246
*/
245-
public static void registerWrenchTool(String callback) {
247+
public static void registerWrenchTool(final String callback) {
246248
FMLInterModComms.sendMessage(MOD_ID, "registerWrenchTool", callback);
247249
}
248250

@@ -265,7 +267,7 @@ public static void registerWrenchTool(String callback) {
265267
*
266268
* @param callback the callback to register as a wrench tool tester.
267269
*/
268-
public static void registerWrenchToolCheck(String callback) {
270+
public static void registerWrenchToolCheck(final String callback) {
269271
FMLInterModComms.sendMessage(MOD_ID, "registerWrenchToolCheck", callback);
270272
}
271273

@@ -291,7 +293,7 @@ public static void registerWrenchToolCheck(String callback) {
291293
* @param canCharge the callback to register for checking chargeability.
292294
* @param charge the callback to register for charging items.
293295
*/
294-
public static void registerItemCharge(String name, String canCharge, String charge) {
296+
public static void registerItemCharge(final String name, final String canCharge, final String charge) {
295297
final NBTTagCompound nbt = new NBTTagCompound();
296298
nbt.setString("name", name);
297299
nbt.setString("canCharge", canCharge);
@@ -319,7 +321,7 @@ public static void registerItemCharge(String name, String canCharge, String char
319321
*
320322
* @param callback the callback to register as an ink provider.
321323
*/
322-
public static void registerInkProvider(String callback) {
324+
public static void registerInkProvider(final String callback) {
323325
FMLInterModComms.sendMessage(MOD_ID, "registerInkProvider", callback);
324326
}
325327

@@ -332,7 +334,7 @@ public static void registerInkProvider(String callback) {
332334
*
333335
* @param peripheral the class of the peripheral to blacklist.
334336
*/
335-
public static void blacklistPeripheral(Class peripheral) {
337+
public static void blacklistPeripheral(final Class peripheral) {
336338
FMLInterModComms.sendMessage(MOD_ID, "blacklistPeripheral", peripheral.getName());
337339
}
338340

@@ -351,7 +353,7 @@ public static void blacklistPeripheral(Class peripheral) {
351353
* @param host the class of the host to blacklist the component for.
352354
* @param stack the item stack representing the blacklisted component.
353355
*/
354-
public static void blacklistHost(String name, Class host, ItemStack stack) {
356+
public static void blacklistHost(final String name, final Class host, final ItemStack stack) {
355357
final NBTTagCompound nbt = new NBTTagCompound();
356358
nbt.setString("name", name);
357359
nbt.setString("host", host.getName());
@@ -372,6 +374,44 @@ public static void registerCustomPowerSystem() {
372374
FMLInterModComms.sendMessage(MOD_ID, "registerCustomPowerSystem", "true");
373375
}
374376

377+
/**
378+
* Register a mapping of program name to loot disk.
379+
* <p/>
380+
* The table of mappings is made available to machines to allow displaying
381+
* a message to the user telling her on which floppy disk to find the program
382+
* they were trying to run.
383+
* <p/>
384+
* For Lua programs, this should be the program <em>name</em>, i.e. the file
385+
* name without the <code>.lua</code> extension.
386+
* <p/>
387+
* The list of architectures is optional, if it is not specified this mapping
388+
* will be made available to all architectures. It allows filtering since
389+
* typically programs will be written for one specific architecture type, e.g.
390+
* Lua programs will not (directly) work on a MIPS architecture. The name
391+
* specified is the in the {@link li.cil.oc.api.machine.Architecture.Name}
392+
* annotation of the architecture (also shown in the CPU tooltip).
393+
* <p/>
394+
* The architecture names for Lua are <code>Lua 5.2</code>, <code>Lua 5.3</code>
395+
* and <code>LuaJ</code> for example.
396+
*
397+
* @param programName the name of the program.
398+
* @param diskLabel the label of the disk the program is on.
399+
* @param architectures the names of the architectures this entry applies to.
400+
*/
401+
public static void registerProgramDiskLabel(final String programName, final String diskLabel, final String... architectures) {
402+
final NBTTagCompound nbt = new NBTTagCompound();
403+
nbt.setString("program", programName);
404+
nbt.setString("label", diskLabel);
405+
if (architectures != null && architectures.length > 0) {
406+
final NBTTagList architecturesNbt = new NBTTagList();
407+
for (final String architecture : architectures) {
408+
architecturesNbt.appendTag(new NBTTagString(architecture));
409+
}
410+
nbt.setTag("architectures", architecturesNbt);
411+
}
412+
FMLInterModComms.sendMessage(MOD_ID, "registerProgramDiskLabel", nbt);
413+
}
414+
375415
// ----------------------------------------------------------------------- //
376416

377417
private static final String MOD_ID = "OpenComputers";

‎src/main/resources/assets/opencomputers/lua/machine.lua

+5-2
Original file line numberDiff line numberDiff line change
@@ -1334,8 +1334,11 @@ local libcomputer = {
13341334
beep = function(...)
13351335
return libcomponent.invoke(computer.address(), "beep", ...)
13361336
end,
1337-
getDeviceInfo = function(...)
1338-
return libcomponent.invoke(computer.address(), "getDeviceInfo", ...)
1337+
getDeviceInfo = function()
1338+
return libcomponent.invoke(computer.address(), "getDeviceInfo")
1339+
end,
1340+
getProgramLocations = function()
1341+
return libcomponent.invoke(computer.address(), "getProgramLocations")
13391342
end,
13401343

13411344
getArchitectures = function(...)

‎src/main/scala/li/cil/oc/common/IMC.scala

+8
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ import li.cil.oc.common.template.DisassemblerTemplates
1212
import li.cil.oc.integration.util.ItemCharge
1313
import li.cil.oc.integration.util.Wrench
1414
import li.cil.oc.server.driver.Registry
15+
import li.cil.oc.server.machine.ProgramLocations
16+
import li.cil.oc.util.ExtendedNBT._
1517
import net.minecraft.entity.player.EntityPlayer
1618
import net.minecraft.item.ItemStack
19+
import net.minecraft.nbt.NBTTagString
1720
import net.minecraftforge.common.util.Constants.NBT
1821

1922
import scala.collection.convert.WrapAsScala._
@@ -91,8 +94,13 @@ object IMC {
9194
}
9295
}
9396
else if (message.key == "registerCustomPowerSystem" && message.isStringMessage) {
97+
OpenComputers.log.info(s"Was told there is an unknown power system present by mod ${message.getSender}.")
9498
Settings.get.is3rdPartyPowerSystemPresent = message.getStringValue == "true"
9599
}
100+
else if (message.key == "registerProgramDiskLabel" && message.isNBTMessage) {
101+
OpenComputers.log.info(s"Registering new program location mapping for program '${message.getNBTValue.getString("program")}' being on disk '${message.getNBTValue.getString("label")}' from mod ${message.getSender}.")
102+
ProgramLocations.addMapping(message.getNBTValue.getString("program"), message.getNBTValue.getString("label"), message.getNBTValue.getTagList("architectures", NBT.TAG_STRING).map((tag: NBTTagString) => tag.func_150285_a_()).toArray: _*)
103+
}
96104
else {
97105
OpenComputers.log.warn(s"Got an unrecognized or invalid IMC message '${message.key}' from mod ${message.getSender}.")
98106
}

‎src/main/scala/li/cil/oc/integration/opencomputers/ModOpenComputers.scala

+21
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,30 @@ object ModOpenComputers extends ModProxy {
6767
"OpenComputers",
6868
"li.cil.oc.integration.opencomputers.ModOpenComputers.canCharge",
6969
"li.cil.oc.integration.opencomputers.ModOpenComputers.charge")
70+
7071
api.IMC.registerInkProvider("li.cil.oc.integration.opencomputers.ModOpenComputers.inkCartridgeInkProvider")
7172
api.IMC.registerInkProvider("li.cil.oc.integration.opencomputers.ModOpenComputers.dyeInkProvider")
7273

74+
api.IMC.registerProgramDiskLabel("build", "builder", "Lua 5.2", "Lua 5.3", "LuaJ")
75+
api.IMC.registerProgramDiskLabel("dig", "dig", "Lua 5.2", "Lua 5.3", "LuaJ")
76+
api.IMC.registerProgramDiskLabel("base64", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
77+
api.IMC.registerProgramDiskLabel("deflate", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
78+
api.IMC.registerProgramDiskLabel("gpg", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
79+
api.IMC.registerProgramDiskLabel("inflate", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
80+
api.IMC.registerProgramDiskLabel("md5sum", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
81+
api.IMC.registerProgramDiskLabel("sha256sum", "data", "Lua 5.2", "Lua 5.3", "LuaJ")
82+
api.IMC.registerProgramDiskLabel("refuel", "generator", "Lua 5.2", "Lua 5.3", "LuaJ")
83+
api.IMC.registerProgramDiskLabel("pastebin", "internet", "Lua 5.2", "Lua 5.3", "LuaJ")
84+
api.IMC.registerProgramDiskLabel("wget", "internet", "Lua 5.2", "Lua 5.3", "LuaJ")
85+
api.IMC.registerProgramDiskLabel("irc", "irc", "Lua 5.2", "Lua 5.3", "LuaJ")
86+
api.IMC.registerProgramDiskLabel("maze", "maze", "Lua 5.2", "Lua 5.3", "LuaJ")
87+
api.IMC.registerProgramDiskLabel("arp", "network", "Lua 5.2", "Lua 5.3", "LuaJ")
88+
api.IMC.registerProgramDiskLabel("ifconfig", "network", "Lua 5.2", "Lua 5.3", "LuaJ")
89+
api.IMC.registerProgramDiskLabel("ping", "network", "Lua 5.2", "Lua 5.3", "LuaJ")
90+
api.IMC.registerProgramDiskLabel("route", "network", "Lua 5.2", "Lua 5.3", "LuaJ")
91+
api.IMC.registerProgramDiskLabel("opl-flash", "openloader", "Lua 5.2", "Lua 5.3", "LuaJ")
92+
api.IMC.registerProgramDiskLabel("oppm", "oppm", "Lua 5.2", "Lua 5.3", "LuaJ")
93+
7394
ForgeChunkManager.setForcedChunkLoadingCallback(OpenComputers, ChunkloaderUpgradeHandler)
7495

7596
FMLCommonHandler.instance.bus.register(EventHandler)

‎src/main/scala/li/cil/oc/server/machine/Machine.scala

+4
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,10 @@ class Machine(val host: MachineHost) extends prefab.ManagedEnvironment with mach
452452
}.collect { case Some(kvp) => kvp }.toMap)
453453
}
454454

455+
@Callback(doc = """function():table -- Returns a map of program name to disk label for known programs.""")
456+
def getProgramLocations(context: Context, args: Arguments): Array[AnyRef] =
457+
result(ProgramLocations.getMappings(Machine.getArchitectureName(architecture.getClass)))
458+
455459
// ----------------------------------------------------------------------- //
456460

457461
def isExecuting = state.synchronized(state.contains(Machine.State.Running))

‎src/main/scala/li/cil/oc/server/machine/ProgramLocations.scala

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
package li.cil.oc.server.machine
2+
3+
import scala.collection.mutable
4+
5+
object ProgramLocations {
6+
final val architectureLocations = mutable.Map.empty[String, mutable.Map[String, String]]
7+
final val globalLocations = mutable.Map.empty[String, String]
8+
9+
def addMapping(program: String, label: String, architectures: String*): Unit = {
10+
if (architectures == null || architectures.isEmpty) {
11+
globalLocations += (program -> label)
12+
}
13+
else {
14+
architectures.foreach(architectureLocations.getOrElseUpdate(_, mutable.Map.empty[String, String]) += (program -> label))
15+
}
16+
}
17+
18+
def getMappings(architecture: String) = architectureLocations.getOrElse(architecture, Iterable.empty) ++ globalLocations
19+
}

0 commit comments

Comments
 (0)
Please sign in to comment.