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 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
use std::collections::hash_map::DefaultHasher;
use std::hash::Hash;
use std::hash::Hasher;
use crate::{KOSValueParseError, OpcodeParseError};
/// A struct to iterate over the bytes of a buffer, and keep track of the current position
/// for better error messages
#[derive(Debug, Clone)]
pub struct BufferIterator<'a> {
index: usize,
source: &'a [u8],
}
impl<'a> BufferIterator<'a> {
/// Creates a new BufferIterator over a source buffer
pub fn new(source: &'a [u8]) -> Self {
Self { index: 0, source }
}
/// Peeks the next value in the buffer, if any.
///
/// Returns Some(value) if there is one, or None if EOF has been reached.
pub fn peek(&self) -> Option<u8> {
self.source.get(self.index).copied()
}
/// Returns the current byte index into the file
pub fn current_index(&self) -> usize {
self.index
}
/// Copies the internal buffer to a new Vec<u8>.
pub fn collect_vec(self) -> Vec<u8> {
self.source.to_vec()
}
/// Returns the size of the source buffer
pub fn len(&self) -> usize {
self.source.len()
}
/// Returns true if this iterator is empty
pub fn is_empty(&self) -> bool {
self.current_index() == self.source.len()
}
}
impl Iterator for BufferIterator<'_> {
type Item = u8;
fn next(&mut self) -> Option<Self::Item> {
let b = self.source.get(self.index).copied()?;
// We only increment if we were successful
self.index += 1;
Some(b)
}
fn size_hint(&self) -> (usize, Option<usize>) {
(self.len(), Some(self.len()))
}
}
impl std::io::Read for BufferIterator<'_> {
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
self.source.read(buf)
}
}
/// Allows a type to allow a Kerbal Machine Code or Kerbal Object file to be written into it
pub trait WritableBuffer {
/// Notifies this buffer that if it can, it should resize by the *additional* amount
/// specified
fn allocate_more(&mut self, amount: usize);
/// Writes a single byte to this buffer
fn write(&mut self, val: u8);
/// Writes a byte slice to this buffer
fn write_bytes(&mut self, val: &[u8]);
}
impl WritableBuffer for Vec<u8> {
fn allocate_more(&mut self, amount: usize) {
// If this panics, we are already screwed
self.try_reserve(amount).unwrap();
}
fn write(&mut self, val: u8) {
self.push(val);
}
fn write_bytes(&mut self, val: &[u8]) {
self.extend_from_slice(val);
}
}
/// Allows a type to be converted to bytes and appended to a WriteableBuffer
pub trait ToBytes {
/// Converts a type into bytes and appends it to the buffer.
fn to_bytes(&self, buf: &mut impl WritableBuffer);
}
/// Allows a type to be converted from bytes from a BufferIterator to itself.
pub trait FromBytes {
/// The error type returned when the conversion fails
type Error;
/// Parses a value from the buffer iterator.
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error>
where
Self: Sized;
}
/// The type of an internal value within Kerbal Operating System.
///
/// See [KOSValue](crate::KOSValue) for what these values look like.
///
/// This enum just describes the "type" of the KOSValue, which is stored as a single
/// byte that prefixes the value (if there is one), which allows kOS to know how to interpret
/// the following bytes.
///
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[repr(u8)]
pub enum KOSType {
/// A null value
Null = 0,
/// A raw boolean
Bool = 1,
/// A single (signed) byte
Byte = 2,
/// A signed 16-bit integer
Int16 = 3,
/// A signed 32-bit integer
Int32 = 4,
/// A 32-bit floating point number
Float = 5,
/// A 64-bit floating point number
Double = 6,
/// A raw string
String = 7,
/// An argument marker
ArgMarker = 8,
/// A signed 32-bit integer "value"
ScalarInt = 9,
/// A 64-bit floating point number "value"
ScalarDouble = 10,
/// A boolean "value"
BoolValue = 11,
/// A string "value"
StringValue = 12,
}
impl From<KOSType> for u8 {
fn from(t: KOSType) -> Self {
t as u8
}
}
impl TryFrom<u8> for KOSType {
type Error = ();
fn try_from(value: u8) -> Result<Self, Self::Error> {
match value {
0 => Ok(Self::Null),
1 => Ok(Self::Bool),
2 => Ok(Self::Byte),
3 => Ok(Self::Int16),
4 => Ok(Self::Int32),
5 => Ok(Self::Float),
6 => Ok(Self::Double),
7 => Ok(Self::String),
8 => Ok(Self::ArgMarker),
9 => Ok(Self::ScalarInt),
10 => Ok(Self::ScalarDouble),
11 => Ok(Self::BoolValue),
12 => Ok(Self::StringValue),
_ => Err(()),
}
}
}
impl ToBytes for KOSType {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
(*self as u8).to_bytes(buf);
}
}
impl FromBytes for KOSType {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error>
where
Self: Sized,
{
Self::try_from(u8::from_bytes(source)?)
}
}
/// An internal value within Kerbal Operating System.
///
/// These are documented within the GitHub repo's [KSM Docs](https://github.com/newcomb-luke/kerbalobjects.rs/blob/main/docs/KSM-file-format.md#argument-section).
/// These are used as operands to instructions and stored in the KO file's data section,
/// and a KSM file's argument section.
///
/// Each value takes up 1 byte just for the "data type" so that kOS knows how to load the value.
///
/// The "Value" types (ScalarInt, ScalarDouble, BoolValue, StringValue) are different from their
/// non-value counterparts in that the "Value" types have more built-in suffixes, and are the
/// type used when there are any user-created values, as opposed to instruction operands. See
/// KSM docs for more information.
///
#[derive(Debug, Clone)]
pub enum KOSValue {
/// A null value, rarely used. Only takes up 1 byte.
Null,
/// A boolean. Takes up 2 bytes.
Bool(bool),
/// A signed byte. Takes up 2 bytes.
Byte(i8),
/// A signed 16-bit integer. Takes up 3 bytes.
Int16(i16),
/// A signed 32-bit integer. Takes up 5 bytes.
Int32(i32),
/// A 32-bit floating point number. Takes up 5 bytes.
Float(f32),
/// A 64-bit floating point number. Takes up 9 bytes.
Double(f64),
/// A string. Takes up 2 + length bytes.
String(String),
/// An argument marker. Takes up 1 byte.
ArgMarker,
/// A signed 32-bit integer. Takes up 5 bytes.
ScalarInt(i32),
/// A 64-bit floating point number. Takes up 9 bytes.
ScalarDouble(f64),
/// A boolean. Takes up 2 bytes.
BoolValue(bool),
/// A string. Takes up 2 + length bytes.
StringValue(String),
}
impl KOSValue {
/// Returns the size of the value in bytes.
pub fn size_bytes(&self) -> usize {
match &self {
Self::Null | Self::ArgMarker => 1,
Self::Bool(_) | Self::Byte(_) | Self::BoolValue(_) => 2,
Self::Int16(_) => 3,
Self::Int32(_) | Self::Float(_) | Self::ScalarInt(_) => 5,
Self::Double(_) | Self::ScalarDouble(_) => 9,
Self::String(s) | Self::StringValue(s) => {
2 + s.len() // 1 byte for the type, 1 byte for the length, and then the string
}
}
}
}
impl Hash for KOSValue {
fn hash<H: Hasher>(&self, state: &mut H) {
match self {
Self::Null => 0.hash(state),
Self::Bool(b) => {
1.hash(state);
b.hash(state);
}
Self::Byte(b) => {
2.hash(state);
b.hash(state);
}
Self::Int16(i) => {
3.hash(state);
i.hash(state);
}
Self::Int32(i) => {
4.hash(state);
i.hash(state);
}
Self::Float(f) => {
5.hash(state);
f.to_bits().hash(state);
}
Self::Double(d) => {
6.hash(state);
d.to_bits().hash(state);
}
Self::String(s) => {
7.hash(state);
s.hash(state);
}
Self::ArgMarker => {
8.hash(state);
}
Self::ScalarInt(i) => {
9.hash(state);
i.hash(state);
}
Self::ScalarDouble(d) => {
10.hash(state);
d.to_bits().hash(state);
}
Self::BoolValue(b) => {
11.hash(state);
b.hash(state);
}
Self::StringValue(s) => {
12.hash(state);
s.hash(state);
}
}
}
}
impl PartialEq for KOSValue {
fn eq(&self, other: &Self) -> bool {
let mut hasher_1 = DefaultHasher::new();
self.hash(&mut hasher_1);
let mut hasher_2 = DefaultHasher::new();
other.hash(&mut hasher_2);
hasher_1.finish() == hasher_2.finish()
}
}
impl Eq for KOSValue {}
impl ToBytes for KOSValue {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
match self {
Self::Null => {
buf.write(0);
}
Self::Bool(b) => {
buf.write(1);
b.to_bytes(buf);
}
Self::Byte(b) => {
buf.write(2);
b.to_bytes(buf);
}
Self::Int16(i) => {
buf.write(3);
i.to_bytes(buf);
}
Self::Int32(i) => {
buf.write(4);
i.to_bytes(buf);
}
Self::Float(f) => {
buf.write(5);
f.to_bytes(buf);
}
Self::Double(f) => {
buf.write(6);
f.to_bytes(buf);
}
Self::String(s) => {
buf.write(7);
buf.write(s.len() as u8);
s.to_bytes(buf);
}
Self::ArgMarker => {
buf.write(8);
}
Self::ScalarInt(i) => {
buf.write(9);
i.to_bytes(buf);
}
Self::ScalarDouble(f) => {
buf.write(10);
f.to_bytes(buf);
}
Self::BoolValue(b) => {
buf.write(11);
b.to_bytes(buf);
}
Self::StringValue(s) => {
buf.write(12);
buf.write(s.len() as u8);
s.to_bytes(buf);
}
}
}
}
impl FromBytes for KOSValue {
type Error = KOSValueParseError;
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error>
where
Self: Sized,
{
let raw_type = source.next().ok_or(KOSValueParseError::EOF)?;
let kos_type =
KOSType::try_from(raw_type).map_err(|_| KOSValueParseError::InvalidType(raw_type))?;
match kos_type {
KOSType::Null => Ok(KOSValue::Null),
KOSType::Bool => bool::from_bytes(source).map(KOSValue::Bool),
KOSType::Byte => i8::from_bytes(source).map(KOSValue::Byte),
KOSType::Int16 => i16::from_bytes(source).map(KOSValue::Int16),
KOSType::Int32 => i32::from_bytes(source).map(KOSValue::Int32),
KOSType::Float => f32::from_bytes(source).map(KOSValue::Float),
KOSType::Double => f64::from_bytes(source).map(KOSValue::Double),
KOSType::String => String::from_bytes(source).map(KOSValue::String),
KOSType::ArgMarker => Ok(KOSValue::ArgMarker),
KOSType::ScalarInt => i32::from_bytes(source).map(KOSValue::ScalarInt),
KOSType::ScalarDouble => f64::from_bytes(source).map(KOSValue::ScalarDouble),
KOSType::BoolValue => bool::from_bytes(source).map(KOSValue::BoolValue),
KOSType::StringValue => String::from_bytes(source).map(KOSValue::StringValue),
}
.map_err(|_| KOSValueParseError::EOF)
}
}
impl ToBytes for bool {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write(if *self { 1 } else { 0 });
}
}
impl ToBytes for u8 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write(*self);
}
}
impl ToBytes for i8 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write((*self) as u8);
}
}
impl ToBytes for u16 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for i16 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for u32 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for i32 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for f32 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for f64 {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(&self.to_le_bytes());
}
}
impl ToBytes for &str {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(self.as_bytes());
}
}
impl ToBytes for String {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write_bytes(self.as_bytes());
}
}
impl FromBytes for bool {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
source.next().map(|x| x != 0).ok_or(())
}
}
impl FromBytes for u8 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
source.next().ok_or(())
}
}
impl FromBytes for i8 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
source.next().map(|x| x as i8).ok_or(())
}
}
impl FromBytes for u16 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 2];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(u16::from_le_bytes(slice))
}
}
impl FromBytes for i16 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 2];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(i16::from_le_bytes(slice))
}
}
impl FromBytes for u32 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 4];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(u32::from_le_bytes(slice))
}
}
impl FromBytes for i32 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 4];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(i32::from_le_bytes(slice))
}
}
impl FromBytes for f32 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 4];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(f32::from_le_bytes(slice))
}
}
impl FromBytes for f64 {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let mut slice = [0u8; 8];
for b in &mut slice {
if let Some(byte) = source.next() {
*b = byte;
} else {
return Err(());
}
}
Ok(f64::from_le_bytes(slice))
}
}
impl FromBytes for String {
type Error = ();
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let len = source.next().ok_or(())? as usize;
let mut s = String::with_capacity(len);
for _ in 0..len {
if let Some(byte) = source.next() {
s.push(byte as char);
} else {
return Err(());
}
}
Ok(s)
}
}
/// The opcode of a kOS machine code instruction.
///
/// Each instruction is made up of an opcode, and a series of zero or more operands.
/// This enum contains all currently supported kOS opcodes, and 2 additional ones.
///
/// Opcode::Bogus is the Opcode variant used to express that it is an unrecognized opcode.
/// This is inspired by the actual kOS C# code.
///
/// Opcode::Pushv is an internal value that is can be used by tools working with kOS machine code,
/// and it represents a normal Opcode::Push instruction, however specifying that the operand should be
/// stored as a KOSValue "Value" type (ScalarDouble, StringValue). This is mostly just useful for the
/// KASM assembler implementation.
///
/// See the [instruction docs](https://github.com/newcomb-luke/kerbalobjects.rs/blob/main/docs/Instruction-docs.md) for
/// more detailed documentation.
///
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum Opcode {
/// Specified also in the kOS C# code, represents an unrecognized Opcode
Bogus,
/// Stop executing for this cycle.
Eof,
/// Aborts the current program and returns to the interpreter.
Eop,
/// No operation: does nothing.
Nop,
/// Consumes the top value of the stack and stores it in the variable named by the operand.
Sto,
/// Consumes the top value of the stack and unsets the variable that it names.
Uns,
/// Gets the suffix of a variable on the stack.
Gmb,
/// Sets the suffix of a variable on the stack.
Smb,
/// Gets the value of an index into a variable on the stack.
Gidx,
/// Sets the value of an index into a variable on the stack.
Sidx,
/// Branches to the provided location if the value on the stack is false.
Bfa,
/// Unconditionally branches to the provided location.
Jmp,
/// Adds two variables on the stack. Also used to concatenate strings.
Add,
/// Subtracts two variables on the stack.
Sub,
/// Multiplies two variables on the stack.
Mul,
/// Divides two variables on the stack.
Div,
/// Raises a value on the stack to another value on the stack.
Pow,
/// Compares two values on the stack. Pushes true if one is greater, false otherwise.
///
/// See instruction docs for the order of values in the comparison.
Cgt,
/// Compares two values on the stack. Pushes true if one is less, false otherwise.
///
/// See instruction docs for the order of values in the comparison.
Clt,
/// Compares two values on the stack. Pushes true if one is greater or equal, false otherwise.
///
/// See instruction docs for the order of values in the comparison.
Cge,
/// Compares two values on the stack. Pushes true if one is less or equal, false otherwise.
///
/// See instruction docs for the order of values in the comparison.
Cle,
/// Compares two values on the stack. Pushes true if both are equal, false otherwise.
Ceq,
/// Compares two values on the stack. Pushes true if both are not equal, false otherwise.
Cne,
/// Consumes a value on the stack, and pushes back the negative.
Neg,
/// Converts a value on the stack into a boolean.
///
/// See instruction docs for how the conversion is performed.
Bool,
/// Converts a value on the stack into a boolean, and pushes the negated value.
///
/// See instruction docs for how the conversion is performed.
Not,
/// Performs the logical AND operation between boolean values.
And,
/// Performs the logical OR operation between boolean values.
Or,
/// Calls a function.
///
/// See instruction docs for call instruction format.
Call,
/// Returns from a function call.
Ret,
/// Pushes a value to the stack.
Push,
/// Pops a value off of the stack and discards it.
Pop,
/// Duplicates the value on the top of the stack.
Dup,
/// Swaps the top value of the stack with the value just below.
Swap,
/// "Evaluates" the top value of the stack. Usually this replaces a variable name with
/// the variable's value.
Eval,
/// Adds a new kOS trigger.
Addt,
/// Removes a kOS trigger.
Rmvt,
/// Waits for a specified amount of time.
Wait,
/// Gets the suffixed method of a variable on the stack.
Gmet,
/// Consumes the top value of the stack and stores it in the variable named by the operand.
/// If the variable of the provided name does not exist, a new local variable is created.
Stol,
/// Consumes the top value of the stack and stores it in the variable named by the operand.
/// If the variable of the provided name does not exist, a new global variable is created.
Stog,
/// Begins a new variable scope
Bscp,
/// Ends a scope named by the provided id.
Escp,
/// Consumes the top value of the stack and stores it in the variable named by the operand.
/// If the variable of the provided name does not exist, an error occurs.
Stoe,
/// Pushes a function delegate to the stack.
Phdl,
/// Branches to the provided location if the value on the stack is true.
Btr,
/// Checks if the provided variable name exists.
Exst,
/// Asserts that the top of the stack is a KOSValue::ArgMarker
Argb,
/// Pushes true if the top of the stack is a KOSValue::ArgMarker, false if not.
Targ,
/// Tests if the current trigger is requested to be cancelled. Pushes true if it is, false if not.
Tcan,
/// Pushes a value that is replaced with the correct value after the file is loaded.
Prl,
/// Pushes a function delegate that is replaced with the correct value after the file is loaded.
Pdrl,
/// Resets the current internal kOS label value.
Lbrt,
/// An internal value created for use by the Kerbal Assembler. This is not an opcode recognized
/// by kOS, and should always be replaced with a regular Opcode::Push. This exists to be a
/// special instruction that pushes the "Value" version of an argument.
Pushv,
}
impl Opcode {
/// Returns the number of operands that this instruction type should have.
pub fn num_operands(&self) -> usize {
match self {
Opcode::Eof => 0,
Opcode::Eop => 0,
Opcode::Nop => 0,
Opcode::Sto => 1,
Opcode::Uns => 0,
Opcode::Gmb => 1,
Opcode::Smb => 1,
Opcode::Gidx => 0,
Opcode::Sidx => 0,
Opcode::Bfa => 1,
Opcode::Jmp => 1,
Opcode::Add => 0,
Opcode::Sub => 0,
Opcode::Mul => 0,
Opcode::Div => 0,
Opcode::Pow => 0,
Opcode::Cgt => 0,
Opcode::Clt => 0,
Opcode::Cge => 0,
Opcode::Cle => 0,
Opcode::Ceq => 0,
Opcode::Cne => 0,
Opcode::Neg => 0,
Opcode::Bool => 0,
Opcode::Not => 0,
Opcode::And => 0,
Opcode::Or => 0,
Opcode::Call => 2,
Opcode::Ret => 1,
Opcode::Push => 1,
Opcode::Pop => 0,
Opcode::Dup => 0,
Opcode::Swap => 0,
Opcode::Eval => 0,
Opcode::Addt => 2,
Opcode::Rmvt => 0,
Opcode::Wait => 0,
Opcode::Gmet => 1,
Opcode::Stol => 1,
Opcode::Stog => 1,
Opcode::Bscp => 2,
Opcode::Escp => 1,
Opcode::Stoe => 1,
Opcode::Phdl => 2,
Opcode::Btr => 1,
Opcode::Exst => 0,
Opcode::Argb => 0,
Opcode::Targ => 0,
Opcode::Tcan => 0,
Opcode::Prl => 1,
Opcode::Pdrl => 2,
Opcode::Lbrt => 1,
Opcode::Pushv => 1,
Opcode::Bogus => 0,
}
}
}
impl From<u8> for Opcode {
fn from(byte: u8) -> Self {
match byte {
0x31 => Opcode::Eof,
0x32 => Opcode::Eop,
0x33 => Opcode::Nop,
0x34 => Opcode::Sto,
0x35 => Opcode::Uns,
0x36 => Opcode::Gmb,
0x37 => Opcode::Smb,
0x38 => Opcode::Gidx,
0x39 => Opcode::Sidx,
0x3a => Opcode::Bfa,
0x3b => Opcode::Jmp,
0x3c => Opcode::Add,
0x3d => Opcode::Sub,
0x3e => Opcode::Mul,
0x3f => Opcode::Div,
0x40 => Opcode::Pow,
0x41 => Opcode::Cgt,
0x42 => Opcode::Clt,
0x43 => Opcode::Cge,
0x44 => Opcode::Cle,
0x45 => Opcode::Ceq,
0x46 => Opcode::Cne,
0x47 => Opcode::Neg,
0x48 => Opcode::Bool,
0x49 => Opcode::Not,
0x4a => Opcode::And,
0x4b => Opcode::Or,
0x4c => Opcode::Call,
0x4d => Opcode::Ret,
0x4e => Opcode::Push,
0x4f => Opcode::Pop,
0x50 => Opcode::Dup,
0x51 => Opcode::Swap,
0x52 => Opcode::Eval,
0x53 => Opcode::Addt,
0x54 => Opcode::Rmvt,
0x55 => Opcode::Wait,
0x57 => Opcode::Gmet,
0x58 => Opcode::Stol,
0x59 => Opcode::Stog,
0x5a => Opcode::Bscp,
0x5b => Opcode::Escp,
0x5c => Opcode::Stoe,
0x5d => Opcode::Phdl,
0x5e => Opcode::Btr,
0x5f => Opcode::Exst,
0x60 => Opcode::Argb,
0x61 => Opcode::Targ,
0x62 => Opcode::Tcan,
0xce => Opcode::Prl,
0xcd => Opcode::Pdrl,
0xf0 => Opcode::Lbrt,
0xfa => Opcode::Pushv,
_ => Opcode::Bogus,
}
}
}
impl From<Opcode> for u8 {
fn from(opcode: Opcode) -> Self {
match opcode {
Opcode::Bogus => 0x00,
Opcode::Eof => 0x31,
Opcode::Eop => 0x32,
Opcode::Nop => 0x33,
Opcode::Sto => 0x34,
Opcode::Uns => 0x35,
Opcode::Gmb => 0x36,
Opcode::Smb => 0x37,
Opcode::Gidx => 0x38,
Opcode::Sidx => 0x39,
Opcode::Bfa => 0x3a,
Opcode::Jmp => 0x3b,
Opcode::Add => 0x3c,
Opcode::Sub => 0x3d,
Opcode::Mul => 0x3e,
Opcode::Div => 0x3f,
Opcode::Pow => 0x40,
Opcode::Cgt => 0x41,
Opcode::Clt => 0x42,
Opcode::Cge => 0x43,
Opcode::Cle => 0x44,
Opcode::Ceq => 0x45,
Opcode::Cne => 0x46,
Opcode::Neg => 0x47,
Opcode::Bool => 0x48,
Opcode::Not => 0x49,
Opcode::And => 0x4a,
Opcode::Or => 0x4b,
Opcode::Call => 0x4c,
Opcode::Ret => 0x4d,
Opcode::Push => 0x4e,
Opcode::Pop => 0x4f,
Opcode::Dup => 0x50,
Opcode::Swap => 0x51,
Opcode::Eval => 0x52,
Opcode::Addt => 0x53,
Opcode::Rmvt => 0x54,
Opcode::Wait => 0x55,
Opcode::Gmet => 0x57,
Opcode::Stol => 0x58,
Opcode::Stog => 0x59,
Opcode::Bscp => 0x5a,
Opcode::Escp => 0x5b,
Opcode::Stoe => 0x5c,
Opcode::Phdl => 0x5d,
Opcode::Btr => 0x5e,
Opcode::Exst => 0x5f,
Opcode::Argb => 0x60,
Opcode::Targ => 0x61,
Opcode::Tcan => 0x62,
Opcode::Prl => 0xce,
Opcode::Pdrl => 0xcd,
Opcode::Lbrt => 0xf0,
Opcode::Pushv => 0xfa,
}
}
}
impl From<&str> for Opcode {
fn from(s: &str) -> Self {
match s {
"eof" => Opcode::Eof,
"eop" => Opcode::Eop,
"nop" => Opcode::Nop,
"sto" => Opcode::Sto,
"uns" => Opcode::Uns,
"gmb" => Opcode::Gmb,
"smb" => Opcode::Smb,
"gidx" => Opcode::Gidx,
"sidx" => Opcode::Sidx,
"bfa" => Opcode::Bfa,
"jmp" => Opcode::Jmp,
"add" => Opcode::Add,
"sub" => Opcode::Sub,
"mul" => Opcode::Mul,
"div" => Opcode::Div,
"pow" => Opcode::Pow,
"cgt" => Opcode::Cgt,
"clt" => Opcode::Clt,
"cge" => Opcode::Cge,
"cle" => Opcode::Cle,
"ceq" => Opcode::Ceq,
"cne" => Opcode::Cne,
"neg" => Opcode::Neg,
"bool" => Opcode::Bool,
"not" => Opcode::Not,
"and" => Opcode::And,
"or" => Opcode::Or,
"call" => Opcode::Call,
"ret" => Opcode::Ret,
"push" => Opcode::Push,
"pop" => Opcode::Pop,
"dup" => Opcode::Dup,
"swap" => Opcode::Swap,
"eval" => Opcode::Eval,
"addt" => Opcode::Addt,
"rmvt" => Opcode::Rmvt,
"wait" => Opcode::Wait,
"gmet" => Opcode::Gmet,
"stol" => Opcode::Stol,
"stog" => Opcode::Stog,
"bscp" => Opcode::Bscp,
"escp" => Opcode::Escp,
"stoe" => Opcode::Stoe,
"phdl" => Opcode::Phdl,
"btr" => Opcode::Btr,
"exst" => Opcode::Exst,
"argb" => Opcode::Argb,
"targ" => Opcode::Targ,
"tcan" => Opcode::Tcan,
"prl" => Opcode::Prl,
"pdrl" => Opcode::Pdrl,
"lbrt" => Opcode::Lbrt,
"pushv" => Opcode::Pushv,
&_ => Opcode::Bogus,
}
}
}
impl From<Opcode> for &str {
fn from(opcode: Opcode) -> Self {
match opcode {
Opcode::Eof => "eof",
Opcode::Eop => "eop",
Opcode::Nop => "nop",
Opcode::Sto => "sto",
Opcode::Uns => "uns",
Opcode::Gmb => "gmb",
Opcode::Smb => "smb",
Opcode::Gidx => "gidx",
Opcode::Sidx => "sidx",
Opcode::Bfa => "bfa",
Opcode::Jmp => "jmp",
Opcode::Add => "add",
Opcode::Sub => "sub",
Opcode::Mul => "mul",
Opcode::Div => "div",
Opcode::Pow => "pow",
Opcode::Cgt => "cgt",
Opcode::Clt => "clt",
Opcode::Cge => "cge",
Opcode::Cle => "cle",
Opcode::Ceq => "ceq",
Opcode::Cne => "cne",
Opcode::Neg => "neg",
Opcode::Bool => "bool",
Opcode::Not => "not",
Opcode::And => "and",
Opcode::Or => "or",
Opcode::Call => "call",
Opcode::Ret => "ret",
Opcode::Push => "push",
Opcode::Pop => "pop",
Opcode::Dup => "dup",
Opcode::Swap => "swap",
Opcode::Eval => "eval",
Opcode::Addt => "addt",
Opcode::Rmvt => "rmvt",
Opcode::Wait => "wait",
Opcode::Gmet => "gmet",
Opcode::Stol => "stol",
Opcode::Stog => "stog",
Opcode::Bscp => "bscp",
Opcode::Escp => "escp",
Opcode::Stoe => "stoe",
Opcode::Phdl => "phdl",
Opcode::Btr => "btr",
Opcode::Exst => "exst",
Opcode::Argb => "argb",
Opcode::Targ => "targ",
Opcode::Tcan => "tcan",
Opcode::Prl => "prl",
Opcode::Pdrl => "pdrl",
Opcode::Lbrt => "lbrt",
Opcode::Pushv => "pushv",
Opcode::Bogus => "bogus",
}
}
}
impl ToBytes for Opcode {
fn to_bytes(&self, buf: &mut impl WritableBuffer) {
buf.write((*self).into());
}
}
impl FromBytes for Opcode {
type Error = OpcodeParseError;
fn from_bytes(source: &mut BufferIterator) -> Result<Self, Self::Error> {
let value = source.next().ok_or(OpcodeParseError::EOF)?;
let opcode = Opcode::from(value);
match opcode {
Opcode::Bogus => Err(OpcodeParseError::InvalidOpcode(value)),
_ => Ok(opcode),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn null_to_bytes() {
let v = KOSValue::Null;
let mut buf = Vec::with_capacity(1);
v.to_bytes(&mut buf);
assert_eq!(buf, vec![0]);
}
#[test]
fn bool_to_bytes() {
let v1 = KOSValue::Bool(true);
let v2 = KOSValue::Bool(false);
let mut buf = Vec::with_capacity(2);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![1, 1]);
buf.clear();
v2.to_bytes(&mut buf);
assert_eq!(buf, vec![1, 0]);
}
#[test]
fn byte_to_bytes() {
let v1 = KOSValue::Byte(0);
let v2 = KOSValue::Byte(-128);
let mut buf = Vec::with_capacity(2);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![2, 0]);
buf.clear();
v2.to_bytes(&mut buf);
assert_eq!(buf, vec![2, -128i8 as u8]);
}
#[test]
fn int16_to_bytes() {
let v1 = KOSValue::Int16(526);
let mut buf = Vec::with_capacity(3);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![3, 0b00001110, 0b00000010]);
}
#[test]
fn int32_to_bytes() {
let v1 = KOSValue::Int32(-764);
let mut buf = Vec::with_capacity(5);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![4, 0b00000100, 0b11111101, 0b11111111, 0b11111111]);
}
#[test]
fn float_to_bytes() {
let v1 = KOSValue::Float(3.14159);
let mut buf = Vec::with_capacity(5);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![5, 208, 15, 73, 64]);
}
#[test]
fn double_to_bytes() {
let v1 = KOSValue::Double(3.14159);
let mut buf = Vec::with_capacity(9);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![6, 110, 134, 27, 240, 249, 33, 9, 64]);
}
#[test]
fn string_to_bytes() {
let v1 = KOSValue::String(String::from("test str"));
let mut buf = Vec::with_capacity(10);
v1.to_bytes(&mut buf);
assert_eq!(
buf,
vec![7, 8, b't', b'e', b's', b't', b' ', b's', b't', b'r']
);
}
#[test]
fn argmarker_to_bytes() {
let v1 = KOSValue::ArgMarker;
let mut buf = Vec::with_capacity(1);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![8]);
}
#[test]
fn scalarint_to_bytes() {
let v1 = KOSValue::ScalarInt(-1267);
let mut buf = Vec::with_capacity(5);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![9, 0b00001101, 0b11111011, 0b11111111, 0b11111111]);
}
#[test]
fn scalardouble_to_bytes() {
let v1 = KOSValue::ScalarDouble(3.14159);
let mut buf = Vec::with_capacity(9);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![10, 110, 134, 27, 240, 249, 33, 9, 64]);
}
#[test]
fn boolvalue_to_bytes() {
let v1 = KOSValue::BoolValue(true);
let v2 = KOSValue::BoolValue(false);
let mut buf = Vec::with_capacity(2);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![11, 1]);
buf.clear();
v2.to_bytes(&mut buf);
assert_eq!(buf, vec![11, 0]);
}
#[test]
fn stringvalue_to_bytes() {
let v1 = KOSValue::StringValue(String::from("hello"));
let mut buf = Vec::with_capacity(7);
v1.to_bytes(&mut buf);
assert_eq!(buf, vec![12, 5, b'h', b'e', b'l', b'l', b'o']);
}
}