mainframe_program

Mainframe programs represent computer programs, and are responsible for carrying out an instruction or set of instructions specified by commands passed to them. Unlike real computer programs, mainframe programs are not in possession of any ingame representation of "source code" and are hardcoded. Most of DWAINE's functionality is provided by computer programs, which include the kernel, the shell, the drivers, and system utilities (ls, cd, etc...), among other programs.

Vars
executable	Whether this program can be executed by the kernel.
initialized	Whether this program has been initialised and is running.
master	The mainframe computer that this program is bring run by.
needs_holder	Whether this program requires a holder data disc.
parent_id	The program ID of this program's parent task.
parent_task	The parent task of this program. This corresponds to the program that initialised this program.
progid	The program ID of this program. This corresponds to the position of this program in the mainframe's processing list.
useracc	This program's current user.
Procs
check_mode_permission	Check that the specified user has the required permissions to alter the metadata and permission level of the target file or folder.
check_read_permission	Check that the specified user has the required permissions to read the content of the target file or folder.
check_write_permission	Check that the specified user has the required permissions to write to the target file or folder.
ensure_program	Ensure that the program is configured correctly. Returns `TRUE` on success, `FALSE` on failure.
get_computer_datum	Find any computer datum with a given name.
get_file_name	Find a file with a given name.
get_folder_name	Find a folder with a given name.
handle_quit	Handle program exiting. If a program should end intentionally, an exit system call should be sent to the OS through `mainframe_prog_exit`. The program will not exit otherwise, even if nothing bothers to send it more input.
initialize	Initialise this program. Called when this program starts running.
input_text	Pass text to this program; this text is typically interpreted as a command.
is_name_invalid	Check if a filename is invalid somehow.
message_user	Instruct the parent task to pass an output string to the user terminal, with optional render options. This allows for piping operations.
parse_string	Format a string into a command and substitute variable names with their values.
process	Called by the mainframe processing loop, in sync with the machinery processing loop.
read_user_field	Read a field from the current user's user file.
receive_progsignal	Called when this program receives a signal.
signal_program	Send a signal from this program to its mainframe computer.
unloaded	Called when this program is unloaded.
write_user_field	Read a value to a field from the current user's user file.

Var Details

var
executable
–

Whether this program can be executed by the kernel.

var
initialized
– /tmp

Whether this program has been initialised and is running.

var
master
– /obj/machinery/networked/mainframe

The mainframe computer that this program is bring run by.

var
needs_holder
–

Whether this program requires a holder data disc.

var
parent_id
– /tmp

The program ID of this program's parent task.

var
parent_task
– /tmp/datum/computer/file/mainframe_program

The parent task of this program. This corresponds to the program that initialised this program.

var
progid
– /tmp

The program ID of this program. This corresponds to the position of this program in the mainframe's processing list.

var
useracc
– /tmp/datum/mainframe2_user_data

This program's current user.

Proc Details

proc
check_mode_permission
(/datum/computer/target, /datum/mainframe2_user_data/user)

Check that the specified user has the required permissions to alter the metadata and permission level of the target file or folder.

proc
check_read_permission
(/datum/computer/target, /datum/mainframe2_user_data/user)

Check that the specified user has the required permissions to read the content of the target file or folder.

proc
check_write_permission
(/datum/computer/target, /datum/mainframe2_user_data/user)

Check that the specified user has the required permissions to write to the target file or folder.

proc
ensure_program
()

Ensure that the program is configured correctly. Returns TRUE on success, FALSE on failure.

proc
get_computer_datum
(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

Find any computer datum with a given name.

proc
get_file_name
(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

Find a file with a given name.

proc
get_folder_name
(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

Find a folder with a given name.

proc
handle_quit
()

Handle program exiting. If a program should end intentionally, an exit system call should be sent to the OS through mainframe_prog_exit. The program will not exit otherwise, even if nothing bothers to send it more input.

proc
initialize
(initparams)

Initialise this program. Called when this program starts running.

proc
input_text
(text)

Pass text to this program; this text is typically interpreted as a command.

proc
is_name_invalid
(string)

Check if a filename is invalid somehow.

proc
message_user
(msg, render, file)

Instruct the parent task to pass an output string to the user terminal, with optional render options. This allows for piping operations.

proc
parse_string
(string, /list/replace_list)

Format a string into a command and substitute variable names with their values.

proc
process
()

Called by the mainframe processing loop, in sync with the machinery processing loop.

proc
read_user_field
(field)

Read a field from the current user's user file.

proc
receive_progsignal
(sendid, /list/data, /datum/computer/file/file)

Called when this program receives a signal.

proc
signal_program
(progid, /list/data, /datum/computer/file/file)

Send a signal from this program to its mainframe computer.

proc
unloaded
()

Called when this program is unloaded.

proc
write_user_field
(field, data)

Read a value to a field from the current user's user file.

mainframe program /datum/computer/file/mainframe_program

Vars

Procs

Var Details

var executable –

var initialized – /tmp

var master – /obj/machinery/networked/mainframe

var needs_holder –

var parent_id – /tmp

var parent_task – /tmp/datum/computer/file/mainframe_program

var progid – /tmp

var useracc – /tmp/datum/mainframe2_user_data

Proc Details

proc check_mode_permission(/datum/computer/target, /datum/mainframe2_user_data/user)

proc check_read_permission(/datum/computer/target, /datum/mainframe2_user_data/user)

proc check_write_permission(/datum/computer/target, /datum/mainframe2_user_data/user)

proc ensure_program()

proc get_computer_datum(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

proc get_file_name(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

proc get_folder_name(string, /datum/computer/folder/check_folder, /datum/mainframe2_user_data/user)

proc handle_quit()

proc initialize(initparams)

proc input_text(text)

proc is_name_invalid(string)

proc message_user(msg, render, file)

proc parse_string(string, /list/replace_list)

proc process()

proc read_user_field(field)

proc receive_progsignal(sendid, /list/data, /datum/computer/file/file)

proc signal_program(progid, /list/data, /datum/computer/file/file)

proc unloaded()

proc write_user_field(field, data)