Added better descriptive error messages for file operations in core_bind.cpp

This commit is contained in:
unknown 2020-10-29 16:09:42 +05:30 committed by Anutrix
parent 468b987aa3
commit 73c5e07051

View file

@ -1077,79 +1077,79 @@ bool File::is_open() const {
} }
String File::get_path() const { String File::get_path() const {
ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use, or is lacking read-write permission.");
return f->get_path(); return f->get_path();
} }
String File::get_path_absolute() const { String File::get_path_absolute() const {
ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use, or is lacking read-write permission.");
return f->get_path_absolute(); return f->get_path_absolute();
} }
void File::seek(int64_t p_position) { void File::seek(int64_t p_position) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
ERR_FAIL_COND_MSG(p_position < 0, "Seek position must be a positive integer."); ERR_FAIL_COND_MSG(p_position < 0, "Seek position must be a positive integer.");
f->seek(p_position); f->seek(p_position);
} }
void File::seek_end(int64_t p_position) { void File::seek_end(int64_t p_position) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->seek_end(p_position); f->seek_end(p_position);
} }
uint64_t File::get_position() const { uint64_t File::get_position() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_position(); return f->get_position();
} }
uint64_t File::get_length() const { uint64_t File::get_length() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_length(); return f->get_length();
} }
bool File::eof_reached() const { bool File::eof_reached() const {
ERR_FAIL_COND_V_MSG(!f, false, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, false, "File must be opened before use, or is lacking read-write permission.");
return f->eof_reached(); return f->eof_reached();
} }
uint8_t File::get_8() const { uint8_t File::get_8() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_8(); return f->get_8();
} }
uint16_t File::get_16() const { uint16_t File::get_16() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_16(); return f->get_16();
} }
uint32_t File::get_32() const { uint32_t File::get_32() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_32(); return f->get_32();
} }
uint64_t File::get_64() const { uint64_t File::get_64() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_64(); return f->get_64();
} }
float File::get_float() const { float File::get_float() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_float(); return f->get_float();
} }
double File::get_double() const { double File::get_double() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_double(); return f->get_double();
} }
real_t File::get_real() const { real_t File::get_real() const {
ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, 0, "File must be opened before use, or is lacking read-write permission.");
return f->get_real(); return f->get_real();
} }
Vector<uint8_t> File::get_buffer(int64_t p_length) const { Vector<uint8_t> File::get_buffer(int64_t p_length) const {
Vector<uint8_t> data; Vector<uint8_t> data;
ERR_FAIL_COND_V_MSG(!f, data, "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, data, "File must be opened before use, or is lacking read-write permission.");
ERR_FAIL_COND_V_MSG(p_length < 0, data, "Length of buffer cannot be smaller than 0."); ERR_FAIL_COND_V_MSG(p_length < 0, data, "Length of buffer cannot be smaller than 0.");
if (p_length == 0) { if (p_length == 0) {
@ -1170,7 +1170,7 @@ Vector<uint8_t> File::get_buffer(int64_t p_length) const {
} }
String File::get_as_text() const { String File::get_as_text() const {
ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use, or is lacking read-write permission.");
String text; String text;
uint64_t original_pos = f->get_position(); uint64_t original_pos = f->get_position();
@ -1197,12 +1197,12 @@ String File::get_sha256(const String &p_path) const {
} }
String File::get_line() const { String File::get_line() const {
ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, String(), "File must be opened before use, or is lacking read-write permission.");
return f->get_line(); return f->get_line();
} }
Vector<String> File::get_csv_line(const String &p_delim) const { Vector<String> File::get_csv_line(const String &p_delim) const {
ERR_FAIL_COND_V_MSG(!f, Vector<String>(), "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, Vector<String>(), "File must be opened before use, or is lacking read-write permission.");
return f->get_csv_line(p_delim); return f->get_csv_line(p_delim);
} }
@ -1230,77 +1230,77 @@ Error File::get_error() const {
} }
void File::store_8(uint8_t p_dest) { void File::store_8(uint8_t p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_8(p_dest); f->store_8(p_dest);
} }
void File::store_16(uint16_t p_dest) { void File::store_16(uint16_t p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_16(p_dest); f->store_16(p_dest);
} }
void File::store_32(uint32_t p_dest) { void File::store_32(uint32_t p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_32(p_dest); f->store_32(p_dest);
} }
void File::store_64(uint64_t p_dest) { void File::store_64(uint64_t p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_64(p_dest); f->store_64(p_dest);
} }
void File::store_float(float p_dest) { void File::store_float(float p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_float(p_dest); f->store_float(p_dest);
} }
void File::store_double(double p_dest) { void File::store_double(double p_dest) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_double(p_dest); f->store_double(p_dest);
} }
void File::store_real(real_t p_real) { void File::store_real(real_t p_real) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_real(p_real); f->store_real(p_real);
} }
void File::store_string(const String &p_string) { void File::store_string(const String &p_string) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_string(p_string); f->store_string(p_string);
} }
void File::store_pascal_string(const String &p_string) { void File::store_pascal_string(const String &p_string) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_pascal_string(p_string); f->store_pascal_string(p_string);
} }
String File::get_pascal_string() { String File::get_pascal_string() {
ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, "", "File must be opened before use, or is lacking read-write permission.");
return f->get_pascal_string(); return f->get_pascal_string();
} }
void File::store_line(const String &p_string) { void File::store_line(const String &p_string) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_line(p_string); f->store_line(p_string);
} }
void File::store_csv_line(const Vector<String> &p_values, const String &p_delim) { void File::store_csv_line(const Vector<String> &p_values, const String &p_delim) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
f->store_csv_line(p_values, p_delim); f->store_csv_line(p_values, p_delim);
} }
void File::store_buffer(const Vector<uint8_t> &p_buffer) { void File::store_buffer(const Vector<uint8_t> &p_buffer) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
uint64_t len = p_buffer.size(); uint64_t len = p_buffer.size();
if (len == 0) { if (len == 0) {
@ -1317,7 +1317,7 @@ bool File::file_exists(const String &p_name) const {
} }
void File::store_var(const Variant &p_var, bool p_full_objects) { void File::store_var(const Variant &p_var, bool p_full_objects) {
ERR_FAIL_COND_MSG(!f, "File must be opened before use."); ERR_FAIL_COND_MSG(!f, "File must be opened before use, or is lacking read-write permission.");
int len; int len;
Error err = encode_variant(p_var, nullptr, len, p_full_objects); Error err = encode_variant(p_var, nullptr, len, p_full_objects);
ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant."); ERR_FAIL_COND_MSG(err != OK, "Error when trying to encode Variant.");
@ -1334,7 +1334,7 @@ void File::store_var(const Variant &p_var, bool p_full_objects) {
} }
Variant File::get_var(bool p_allow_objects) const { Variant File::get_var(bool p_allow_objects) const {
ERR_FAIL_COND_V_MSG(!f, Variant(), "File must be opened before use."); ERR_FAIL_COND_V_MSG(!f, Variant(), "File must be opened before use, or is lacking read-write permission.");
uint32_t len = get_32(); uint32_t len = get_32();
Vector<uint8_t> buff = get_buffer(len); Vector<uint8_t> buff = get_buffer(len);
ERR_FAIL_COND_V((uint32_t)buff.size() != len, Variant()); ERR_FAIL_COND_V((uint32_t)buff.size() != len, Variant());