Pbat Language Reference
From Ccwiki
Contents |
Variables
Variables are used to store values.
To set a new variable, you have to specify the type :
SET "STRING" "MY_VARIABLE" "Mod your life"
Possible types are
STRING : string
U8/S8 : Signed/Unsigned 8-bits number
U16/S16 : Signed/Unsigned 16-bits number
U32/S32 : Signed/Unsigned 32-bits number
Signed numbers can be negatives, Unsigned can only be positives.
Examples
SET "U8" "MY_DIGIT" "235" SET "S32" "MY_OTHER_DIGIT" "-3420"
Bug : U8 seems to be buggy. Don't use it.
The best place to define your variables and their types is in the file DEFCONF.PBT.
If you want your variable to be saved in the configuration file of Boot Manager, the name have to begin with "BM.CNF".
Once the type is set, you can assign a new value to the variable :
SET "MY_DIGIT" "34"
Call an existing variable
To call an already defined variable, you have to surround it with $ :
ECHO "$MY_DIGIT$"
will display 34 in the output console.
Messages
Messages can be displayed either on the output console, or in the TV screen.
ECHO "The value of MY_DIGIT is : $MY_DIGIT$"
will return the text and the contain of the variable in the output console which will be in most case the console where you launched ps2client.
MESSAGE "Installation Complete"
will return the text in the TV screen.
You can escape a character with ^
MESSAGE "The Crystal Chip is ^"astonishing^"".
The ^ will tell the MESSAGE command not to interpret the " next to it as the end of the string character.
Widgets
Widgets is used to display menus in the screen. There are many Widget types to feet different needs.
ADDWIDGET "LABEL" "Main Menu"
Types of Widgets
LABEL : to display a title.
ADDWIDGET "LABEL" "$TXT_LABEL$"
will display a title line with the text contained in the variable TXT_LABEL.
CHOICE : to display a choice to set a numerical value to a variable
ADDWIDGET "CHOICE" "Title" "Description" "MY_CHOICE" "CHOICE 1" "CHOICE 2" "CHOICE 3"
will display a widget with the specified title and description (the description is displayed in the scroll bar), and will set the variable MY_CHOICE to "0", "1", or "2" depending of the user choice.
INT : to set a variable with a number
ADDWIDGET "INT" "Title" Description" "MY_NUMBER" "0" "99" 1
will display a widget to store a value between 0 and 99 in the variable MY_NUMBER. The user will be able to increment the number by 1.
AXIS : to set axis numbers (X,Y)
ADDWIDGET "AXIS" "Title" "Description" "VALUE_X" "VALUE_Y" "0" "1920" "1" "0" "1920" "2"
will display the widget which let the user to select a value for VALUE_X between 0 and 1920 with an increment of 1 and for VALUE_Y between 0 and 1920 with an increment of 2.
IP : to set an IP adress
ADDWIDGET "IP" "Title" "Description" "IP_ADDRESS_1" "IP_ADDRESS_2" "IP_ADDRESS_3" "IP_ADDRESS_4"
to set variables IP_ADRESS_1, IP_ADDRESS_2. For example, if you wish to display this IP again, you'll have to call
ECHO "THE IP ADDRESS YOU'VE ENTERED IS $IP_ADDRESS_1$.$IP_ADDRESS_2$.$IP_ADDRESS_3$.$IP_ADDRESS_4$"
CALL : to call another section of the code
ADDWIDGET "CALL" "Title" "Description" "$ARG0$" "THE_SECTION" "ARG_2" "ARG_3"...
will call the section "THE_SECTION" of the file $ARG0$ ($ARG0$ will be the file where this widget is executed. The section THE_SECTION is inside the same file). with arguments ARG_2 and ARG_3.
The text ARG_2 and ARG_3 will be available in the section THE_SECTION by calling variables $ARG2$ and $ARG3$.
(see Sections below)
Other Widget Commands
CLEARWIDGETS without arguments will clear the screen of any widget.
SETTITLE will set the title of the current screen.
Sections
A PBAT script is divided into sections. You can define a new section using the sign ":"
You can navigate thru sections with the GOTO command.
Here is a piece of code to understand how sections work :
GOTO "MAIN_MENU"
:A_SECTION
ECHO "We are in the A_SECTION section".
:MAIN_MENU
ADDWIDGET INT "Value to export" "Choose a number that will be exported to another section" "THE_NUMBER" "0" "10" "1"
ADDWIDGET CALL "Go to Config Menu" "Will display the Config Menu" "$ARG0$" "CONFIG_MENU" " "$THE_NUMBER$"
:CONFIG_MENU
CLEARWIDGETS
MESSAGE "The Number you choose was : $ARG2$"
If this script is called, the section MAIN_MENU will be executed first because of the GOTO. In MAIN_MENU, the variable $THE_NUMBER$ is choosen by the user and the code will jump to CONFIG_MENU with the variable exported.
Conditions
You can execute code with conditions thanks to the IF statement.
IF EQU "$MY_VARIABLE$" "1"
MESSAGE "The Variable was equal to 1"
ELSE
MESSAGE "The Variable was not equal to 1"
ENDIF
You can also turn this code differently :
IF NEQ "$MY_VARIABLE$" "0"
MESSAGE "The Variable was not equal to 0"
ELSE
MESSAGE "The Variable was equal to 0"
ENDIF
you can imbricate more than one IF with the keyword ELSIF :
IF EQU "$MY_VARIABLE$" "1"
MESSAGE "The Variable was equal to 1"
ELSEIF EQU "$MY_VARIABLE$" "2"
MESSAGE "The Variable was equal to 2"
ENDIF
You'll use the ELSEIF statement when you want the second condition to be verified only if the first was true.
When you have many case to treat, you can also use the SWITCH function.
SWITCH "$BM.CNF_VMODE$"
CASE 1
# PAL
SET "BM.CNF_SCREEN_X" "0"
SET "BM.CNF_SCREEN_Y" "0"
BREAK
CASE 2
# VGA
SET "BM.CNF_SCREEN_X" "0"
SET "BM.CNF_SCREEN_Y" "0"
BREAK
CASE 3
# 480P
SET "BM.CNF_SCREEN_X" "0"
SET "BM.CNF_SCREEN_Y" "0"
BREAK
CASE 0
# NTSC
DEFAULT
SET "BM.CNF_SCREEN_X" "0"
SET "BM.CNF_SCREEN_Y" "0"
BREAK
ENDS
You can see that the BREAK command is used to go out of the SWITCH as soon as a case has been treated. You can add DEFAULT to take in consideration this CASE if non corresponds.
File Manipulation
File manipulation is useful for installation scripts (in APPINFO.PBT). You can manipulate files on any device :
- mc0 (for memory card 0)
- mc1 (for memory card 1)
- mass (for USB device)
- dffs (for internal Chip flash memory)
- host (for remote host. Only available if ps2client is launched on the PC and the network and the host server are started on Boot Manager)
COPY : To copy file/directory from source to destination :
COPY "host:/FOLDER/FILE.TXT" "mass:/FOLDER1/FOLDER2/FILE.TXT"
RM : To delete a file or directory
RM "mc0:/TMPFOLDER" will completely delete the folder TMPFOLDER and its contains.
MKDIR : To create a new folder.
MKDIR "mass:/MYFOLDER" will create a folder MYFOLDER in the USB mass storage.
EXISTS : To know if a file/folder exists or not. This command should be used in a IF statement :
IF EXISTS "mc0:/MYFOLDER/MYSCRIPT.PBT"
COPY "mc0:/MYFOLDER/MYSCRIPT.PBT" "mass:/MYFOLDER/MYSCRIPT.PBT"
ENDIF
FPRINT : To write out text into a file.
FPRINT "mass:/MY_TEXT.TXT" "This text will be written into MY_TEXT.TXT."
Be careful, if the file exists already, the content will be replaced.
LOADEXEC : To execute an external file.
LOADEXEC "PBAT" "MY_FILE.PBT" "MY_ARGUMENT1" "MY_ARGUMENT2"
will execute a PBAT file named MY_FILE.PBT with the arguments specified. Most of the time, you'll specify a section of the PBAT script to be executed as the argument.
