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

/*
 * This file is part of libloadorder
 *
 * Copyright (C) 2017 Oliver Hamlet
 *
 * libloadorder is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * libloadorder is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with libloadorder. If not, see <http://www.gnu.org/licenses/>.
 */

use libc::c_uint;

use loadorder::GameId;
use loadorder::LoadOrderMethod;

/// Success return code.
#[no_mangle]
pub static LIBLO_OK: c_uint = 0;

/// There is a mismatch between the files used to keep track of load order.
///
/// This warning can only occur when using libloadorder with a game that uses the textfile-based
/// load order system. The load order in the active plugins list file (`plugins.txt`) does not
/// match the load order in the full load order file (`loadorder.txt`). Synchronisation between
/// the two is automatic when load order is managed through libloadorder. It is left to the client
/// to decide how best to restore synchronisation.
#[no_mangle]
pub static LIBLO_WARN_LO_MISMATCH: c_uint = 2;

/// The specified file is not encoded in UTF-8.
#[no_mangle]
pub static LIBLO_ERROR_FILE_NOT_UTF8: c_uint = 5;

/// The specified file could not be found.
#[no_mangle]
pub static LIBLO_ERROR_FILE_NOT_FOUND: c_uint = 6;

/// A file could not be renamed.
#[no_mangle]
pub static LIBLO_ERROR_FILE_RENAME_FAIL: c_uint = 7;

/// The modification date of a file could not be set.
#[no_mangle]
pub static LIBLO_ERROR_TIMESTAMP_WRITE_FAIL: c_uint = 9;

/// There was an error parsing a plugin file.
#[no_mangle]
pub static LIBLO_ERROR_FILE_PARSE_FAIL: c_uint = 10;

/// Invalid arguments were given for the function.
#[no_mangle]
pub static LIBLO_ERROR_INVALID_ARGS: c_uint = 12;

/// A thread lock was poisoned.
#[no_mangle]
pub static LIBLO_ERROR_POISONED_THREAD_LOCK: c_uint = 14;

/// An unknown I/O error occurred. This is used when the I/O error kind doesn't fit another error
/// code.
#[no_mangle]
pub static LIBLO_ERROR_IO_ERROR: c_uint = 15;

/// Permission denied while trying to access a filesystem path.
#[no_mangle]
pub static LIBLO_ERROR_IO_PERMISSION_DENIED: c_uint = 16;

/// A plugin filename contains characters that do not have Windows-1252 code points, or a character
/// string contains a null character.
#[no_mangle]
pub static LIBLO_ERROR_TEXT_ENCODE_FAIL: c_uint = 17;

/// Text expected to be encoded in Windows-1252 could not be decoded to UTF-8.
#[no_mangle]
pub static LIBLO_ERROR_TEXT_DECODE_FAIL: c_uint = 18;

/// The library encountered an error that should not have been possible to encounter.
#[no_mangle]
pub static LIBLO_ERROR_INTERNAL_LOGIC_ERROR: c_uint = 19;

/// Something panicked.
#[no_mangle]
pub static LIBLO_ERROR_PANICKED: c_uint = 20;

/// Matches the value of the highest-numbered return code.
///
/// Provided in case clients wish to incorporate additional return codes in their implementation
/// and desire some method of avoiding value conflicts.
#[no_mangle]
pub static LIBLO_RETURN_MAX: c_uint = 20;

/// The game handle is using the timestamp-based load order system. Morrowind, Oblivion, Fallout 3
/// and Fallout: New Vegas all use this system.
#[no_mangle]
pub static LIBLO_METHOD_TIMESTAMP: c_uint = LoadOrderMethod::Timestamp as c_uint;

/// he game handle is using the textfile-based load order system. Skyrim uses this system.
#[no_mangle]
pub static LIBLO_METHOD_TEXTFILE: c_uint = LoadOrderMethod::Textfile as c_uint;

/// The asterisk load order system, used by Fallout 4 and Skyrim Special Edition.
#[no_mangle]
pub static LIBLO_METHOD_ASTERISK: c_uint = LoadOrderMethod::Asterisk as c_uint;

/// Game code for The Elder Scrolls III: Morrowind.
#[no_mangle]
pub static LIBLO_GAME_TES3: c_uint = GameId::Morrowind as c_uint;

/// Game code for The Elder Scrolls IV: Oblivion.
#[no_mangle]
pub static LIBLO_GAME_TES4: c_uint = GameId::Oblivion as c_uint;

/// Game code for The Elder Scrolls V: Skyrim.
#[no_mangle]
pub static LIBLO_GAME_TES5: c_uint = GameId::Skyrim as c_uint;

/// Game code for Fallout 3.
#[no_mangle]
pub static LIBLO_GAME_FO3: c_uint = GameId::Fallout3 as c_uint;

/// Game code for Fallout: New Vegas.
#[no_mangle]
pub static LIBLO_GAME_FNV: c_uint = GameId::FalloutNV as c_uint;

/// Game code for Fallout 4.
#[no_mangle]
pub static LIBLO_GAME_FO4: c_uint = GameId::Fallout4 as c_uint;

/// Game code for The Elder Scrolls V: Skyrim Special Edition.
#[no_mangle]
pub static LIBLO_GAME_TES5SE: c_uint = GameId::SkyrimSE as c_uint;

/// Game code for The Elder Scrolls V: Skyrim VR.
#[no_mangle]
pub static LIBLO_GAME_TES5VR: c_uint = GameId::SkyrimVR as c_uint;

/// Game code for Fallout 4 VR.
#[no_mangle]
pub static LIBLO_GAME_FO4VR: c_uint = GameId::Fallout4VR as c_uint;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn game_constants_should_have_expected_integer_values() {
        assert_eq!(1, LIBLO_GAME_TES3);
        assert_eq!(2, LIBLO_GAME_TES4);
        assert_eq!(3, LIBLO_GAME_TES5);
        assert_eq!(4, LIBLO_GAME_FO3);
        assert_eq!(5, LIBLO_GAME_FNV);
        assert_eq!(6, LIBLO_GAME_FO4);
        assert_eq!(7, LIBLO_GAME_TES5SE);
        assert_eq!(8, LIBLO_GAME_FO4VR);
        assert_eq!(9, LIBLO_GAME_TES5VR);
    }
}