├── .gitignore ├── imgs ├── Miv-Logo.png └── screen-shot.png ├── src ├── makefile ├── miv.cc ├── file.hh ├── editor.hh ├── config.hh ├── defines.hh ├── file.cc └── editor.cc ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | miv 2 | *\.out 3 | *\.vimconfig 4 | -------------------------------------------------------------------------------- /imgs/Miv-Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amiremohamadi/miv/HEAD/imgs/Miv-Logo.png -------------------------------------------------------------------------------- /imgs/screen-shot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amiremohamadi/miv/HEAD/imgs/screen-shot.png -------------------------------------------------------------------------------- /src/makefile: -------------------------------------------------------------------------------- 1 | miv: miv.cc editor.hh defines.hh config.hh 2 | g++ `pkg-config --libs ncursesw` *\.cc -o miv 3 | clean: 4 | rm miv 5 | install: 6 | $(miv) 7 | cp miv /usr/bin/miv 8 | -------------------------------------------------------------------------------- /src/miv.cc: -------------------------------------------------------------------------------- 1 | #include "editor.hh" 2 | 3 | int main(int argc, char **argv) { 4 | Editor editor; 5 | 6 | if (argc >= 2) { 7 | editor.set_file(argv[1]); 8 | } 9 | 10 | while (true) { 11 | editor.refresh_screen(); 12 | editor.process_key(); 13 | } 14 | 15 | return 0; 16 | } 17 | -------------------------------------------------------------------------------- /src/file.hh: -------------------------------------------------------------------------------- 1 | #ifndef FILE_HH_ 2 | #define FILE_HH_ 3 | 4 | #include "defines.hh" 5 | #include 6 | #include 7 | #include 8 | 9 | class File { 10 | private: 11 | std::string file; 12 | std::vector lines; 13 | 14 | public: 15 | File(); 16 | File(std::string); 17 | 18 | void open(); 19 | void save(); 20 | void set_file(std::string); 21 | void newline_after(size_t, size_t); 22 | void jointo_nextline(size_t); 23 | size_t jointo_prevline(size_t); 24 | std::wstring &get(size_t); 25 | size_t size(); 26 | bool is_empty(); 27 | }; 28 | 29 | #endif // FILE_HH_ 30 | -------------------------------------------------------------------------------- /src/editor.hh: -------------------------------------------------------------------------------- 1 | #ifndef EDITOR_HH_ 2 | #define EDITOR_HH_ 3 | 4 | #include "config.hh" 5 | #include "file.hh" 6 | #include 7 | #include 8 | 9 | class Editor { 10 | private: 11 | WINDOW *window; 12 | File file; 13 | static Config config; 14 | void _create_win(int, int, int, int); 15 | void _delete_win(); 16 | void _win_resize(); 17 | void _move_cursor(wchar_t); 18 | void _scroll(); 19 | 20 | public: 21 | Editor(); 22 | ~Editor(); 23 | 24 | void set_file(std::string); 25 | void refresh_screen(); 26 | void draw_rows(); 27 | void insert_char(wchar_t); 28 | void remove_char(bool); 29 | void insert_newline(); 30 | void process_key(); 31 | }; 32 | 33 | #endif // EDITOR_HH_ 34 | -------------------------------------------------------------------------------- /src/config.hh: -------------------------------------------------------------------------------- 1 | #ifndef CONFIG_HH_ 2 | #define CONFIG_HH_ 3 | 4 | #include 5 | #include 6 | #include 7 | 8 | #include "defines.hh" 9 | 10 | struct Config { 11 | termios orig_termios; // original termios settings 12 | unsigned int cursor_x, cursor_y; // cursor position 13 | unsigned int row_size, col_size; 14 | unsigned int row_offset, col_offset; 15 | 16 | // i don't know it's a good idea or not! 17 | // but just for having better feeling during 18 | // scrolling down! save current 19 | // x position of the cursor and when cursor y 20 | // changed, set y according to the previous position 21 | unsigned int dummy_cursor_x; 22 | 23 | Config() { 24 | winsize window_size; 25 | 26 | // enable_rawmode() 27 | if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &window_size) == -1 || 28 | window_size.ws_col == 0) 29 | ERROR_HANDLER("error while init editor (get row, col sizes)\n"); 30 | 31 | this->cursor_x = this->cursor_y = 0; 32 | this->col_size = window_size.ws_col; 33 | this->row_size = window_size.ws_row; 34 | this->row_offset = this->col_offset = 0; 35 | 36 | this->dummy_cursor_x = 0; 37 | } 38 | }; 39 | 40 | #endif // CONFIG_HH_ 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | #### Currently under heavy development 4 | 5 | ## What is Miv? 6 |

7 | 8 | Miv is a **STUPID** text editor. The term **"Miv"** has no meaning and is just a play on words with **"Vim"**! 9 | 10 | > It has no superiority over other editors and only is developed for personal purposes! also it can be a good resource if you want to know how text editors work. 11 | 12 | ## Compiling 13 | Clone the project 14 | ```sh 15 | git clone https://github.com/amiremohamadi/miv 16 | ``` 17 | 18 | Run the `makefile`. 19 | ```sh 20 | cd miv/src 21 | make # or sudo make install 22 | ``` 23 | 24 | And use like this: 25 | ```sh 26 | ./miv [path_to_file] 27 | ``` 28 | 29 | ## Usage and default keybindings 30 | You can change default key bindings by editing `defines.hh` file, but default values are: 31 | 32 | | Key | Behaviour | 33 | | ------------- |:-------------:| 34 | | Ctrl + s | Save The File | 35 | | Ctrl + q | Quit | 36 | | Arrow Keys | Move The Cursor| 37 | | Pagedown/Pageup | Move Up And Down| 38 | 39 | **Don't forget, it's super stupid!** 40 | 41 | 42 | ## Requirements 43 | - ncurses (wncurses) 44 | 45 | ## Copying 46 | Available to anybody free of charge, under the terms of GPL V.2 License. 47 | -------------------------------------------------------------------------------- /src/defines.hh: -------------------------------------------------------------------------------- 1 | #ifndef DEFINES_HH_ 2 | #define DEFINES_HH_ 3 | 4 | #include 5 | #include 6 | 7 | #define VERSION "0.0.1" 8 | 9 | #define CTRL_KEY_DOWN 531 10 | #define CTRL_KEY_UP 574 11 | #define CTRL_KEY_RIGHT 568 12 | #define CTRL_KEY_LEFT 553 13 | #define KEY_ESC '\x1b' 14 | #define KEY_RETURN '\n' // this is enter key 15 | 16 | // shortcut keys, change these lines and make your own configuration 17 | #define _KEY_SAVE 's' 18 | #define _KEY_QUIT 'q' 19 | 20 | #define CTRL_KEY(key) (key & 0x1F) // 00011111 -> ctrl is pressed 21 | 22 | #define CAT(A, B) A##B 23 | #define WSTRING(A) CAT(L, #A) 24 | 25 | #define ERROR_HANDLER(msg) \ 26 | do { \ 27 | std::cout << "\x1b[2J"; \ 28 | std::cout << "\x1b[H"; \ 29 | std::cerr << msg; \ 30 | exit(1); \ 31 | } while (false) 32 | 33 | static std::string messages[] = {"MIV -- super stupid text editor", 34 | "VERSION " VERSION, "by @amiremohamadi"}; 35 | 36 | // enum index for color pairs 37 | enum ColorPairs { 38 | BLACK_WHITE = 0, 39 | BLACK_BLUE, 40 | BLACK_RED, 41 | }; 42 | 43 | #endif // DEFINES_HH_ 44 | -------------------------------------------------------------------------------- /src/file.cc: -------------------------------------------------------------------------------- 1 | #include "file.hh" 2 | #include 3 | #include 4 | 5 | File::File() : file() {} 6 | 7 | File::File(std::string file) { this->file = file; } 8 | 9 | void File::open() { 10 | if (this->file.empty()) 11 | ERROR_HANDLER("can't open file (name is empty)"); 12 | 13 | std::wifstream input(file, std::ios::binary); 14 | input.imbue(std::locale("fa_IR")); 15 | 16 | std::wstring line; 17 | while (std::getline(input, line)) 18 | this->lines.push_back(line); 19 | 20 | // when file is empty, this->lines is empty and it leads to occur a bug 21 | // to prevent this, when a file is empty we append a dummy empty line to it 22 | if (this->lines.empty()) 23 | this->lines.push_back(L""); 24 | } 25 | 26 | void File::save() { 27 | if (this->file.empty()) // in case no file is opened 28 | return; // don't do anything 29 | 30 | std::wofstream output(file); 31 | output.imbue(std::locale("fa_IR")); 32 | 33 | for (std::wstring line : lines) { 34 | output << line << '\n'; 35 | } 36 | } 37 | 38 | void File::set_file(std::string file) { this->file = file; } 39 | 40 | void File::newline_after(size_t row, size_t col) { 41 | std::wstring &line = this->get(row); 42 | 43 | // insert new line after row, col 44 | // seek next to indx position 45 | std::vector::iterator row_it = this->lines.begin() + row + 1; 46 | 47 | // get the substring from col to the end of the line 48 | std::wstring newline = line.substr(col); 49 | line = line.substr(0, col); 50 | 51 | // insert the new line 52 | this->lines.insert(row_it, newline); 53 | } 54 | 55 | void File::jointo_nextline(size_t row) { 56 | std::wstring &line = this->get(row); 57 | std::wstring nextline = this->get(row + 1); 58 | 59 | // append next line to the current one 60 | line += nextline; 61 | 62 | // seek to the next line to remove it 63 | std::vector::iterator it = this->lines.begin() + row + 1; 64 | this->lines.erase(it); 65 | } 66 | 67 | size_t File::jointo_prevline(size_t row) { 68 | std::wstring line = this->get(row); 69 | std::wstring &prevline = this->get(row - 1); 70 | 71 | // store prevline size and return it to update cursor_y 72 | size_t ret = prevline.size(); 73 | 74 | // append current line to the previous line 75 | prevline += line; 76 | 77 | // remove current line 78 | std::vector::iterator it = this->lines.begin() + row; 79 | this->lines.erase(it); 80 | 81 | return ret; 82 | } 83 | 84 | std::wstring &File::get(size_t indx) { return this->lines[indx]; } 85 | 86 | size_t File::size() { return this->lines.size(); } 87 | 88 | bool File::is_empty() { return this->file.empty(); } 89 | -------------------------------------------------------------------------------- /src/editor.cc: -------------------------------------------------------------------------------- 1 | #include "editor.hh" 2 | 3 | Config Editor::config; 4 | 5 | Editor::Editor() : file() { 6 | std::setlocale(LC_ALL, ""); // UTF-8 support 7 | initscr(); 8 | 9 | use_default_colors(); 10 | start_color(); 11 | 12 | // define color pairs 13 | init_pair(BLACK_BLUE, COLOR_BLUE, -1); 14 | 15 | _create_win(config.row_size, config.col_size, 0, 0); 16 | keypad(window, TRUE); // enable special keys (like arrow-keys) 17 | 18 | noecho(); // no echo while getch()'ing! 19 | raw(); // enable raw mode (line buffering desable) 20 | 21 | // restore terminal settings at exit 22 | std::atexit([]() { endwin(); }); 23 | } 24 | 25 | Editor::~Editor() { 26 | // free the resources to avoid memory leak 27 | this->_delete_win(); 28 | } 29 | 30 | void Editor::_create_win(int row, int col, int begin_y, int begin_x) { 31 | window = newwin(row, col, 0, 0); 32 | } 33 | 34 | void Editor::_delete_win() { delwin(window); } 35 | 36 | void Editor::_win_resize() { 37 | winsize win; 38 | ioctl(STDOUT_FILENO, TIOCGWINSZ, &win); 39 | 40 | config.row_size = win.ws_row; 41 | config.col_size = win.ws_col; 42 | } 43 | 44 | void Editor::_move_cursor(wchar_t chr) { 45 | size_t row_len = !file.is_empty() ? file.get(config.cursor_y).size() : 0; 46 | 47 | switch (chr) { 48 | case KEY_UP: 49 | config.cursor_y -= config.cursor_y > 0 ? 1 : 0; 50 | break; 51 | 52 | case KEY_DOWN: 53 | config.cursor_y += config.cursor_y < file.size() - 1 ? 1 : 0; 54 | break; 55 | 56 | case KEY_RIGHT: 57 | config.cursor_x += config.cursor_x < row_len ? 1 : 0; 58 | config.dummy_cursor_x = config.cursor_x; 59 | break; 60 | 61 | case KEY_LEFT: 62 | config.cursor_x -= config.cursor_x > 0 ? 1 : 0; 63 | config.dummy_cursor_x = config.cursor_x; 64 | break; 65 | 66 | case KEY_NPAGE: 67 | config.cursor_y += config.cursor_y + config.row_size < file.size() 68 | ? config.row_size - 1 69 | : (file.size() - config.cursor_y) - 1; 70 | break; 71 | 72 | case KEY_PPAGE: 73 | config.cursor_y -= config.cursor_y > config.row_size ? config.row_size - 1 74 | : config.cursor_y; 75 | break; 76 | } 77 | 78 | // update row_len with new values 79 | row_len = !file.is_empty() ? file.get(config.cursor_y).size() : 0; 80 | if (config.cursor_x > row_len) { 81 | config.dummy_cursor_x = config.cursor_x; 82 | config.cursor_x = row_len; 83 | } else if (config.dummy_cursor_x <= row_len) { 84 | // using dummy_cursor_x just for having better experience during 85 | // scrolling! set cursor_x according to previous positions (like vim) 86 | config.cursor_x = config.dummy_cursor_x; 87 | } 88 | } 89 | 90 | void Editor::_scroll() { 91 | if (config.cursor_y < config.row_offset) 92 | config.row_offset = config.cursor_y; 93 | if (config.cursor_y >= config.row_offset + config.row_size) 94 | config.row_offset = config.cursor_y - config.row_size + 1; 95 | if (config.cursor_x < config.col_offset) 96 | config.col_offset = config.cursor_x; 97 | if (config.cursor_x >= config.col_offset + config.col_size) 98 | config.col_offset = config.cursor_x - config.col_size + 1; 99 | } 100 | 101 | void Editor::set_file(std::string file) { 102 | this->file.set_file(file); 103 | this->file.open(); 104 | } 105 | 106 | void Editor::refresh_screen() { 107 | _scroll(); 108 | 109 | // reposition the cursor to write tildes 110 | wmove(window, 0, 0); 111 | draw_rows(); 112 | 113 | // reset cursor position 114 | wmove(window, (config.cursor_y - config.row_offset), 115 | (config.cursor_x - config.col_offset)); 116 | 117 | // show the cursor 118 | wrefresh(window); 119 | } 120 | 121 | void Editor::draw_rows() { 122 | for (int y = 0; y < config.row_size; y++) { 123 | if (y + config.row_offset < this->file.size()) { 124 | std::wstring this_line = file.get(y + config.row_offset); 125 | 126 | int len = this_line.length() - config.col_offset; 127 | if (len < 0) 128 | len = 0; 129 | if (len >= config.col_size) 130 | len = config.col_size - 1; // TODO: remove this with some shitty tricks 131 | 132 | if (len != 0) 133 | waddwstr(window, this_line.substr(config.col_offset, len).c_str()); 134 | waddwstr(window, L"\n"); 135 | } else { 136 | waddwstr(window, L"~\n"); 137 | } 138 | } 139 | 140 | // if no file was opened, print splash messages 141 | if (this->file.is_empty()) { 142 | // messages is the array that is placed in defines.hh 143 | 144 | wattron(window, COLOR_PAIR(BLACK_BLUE)); 145 | 146 | // print the message, center of the screen 147 | unsigned int i = 0; 148 | for (std::string message : messages) { 149 | mvwprintw(window, (config.row_size / 2) + i, 150 | (config.col_size / 2) - (message.size() / 2), message.c_str()); 151 | i++; 152 | } 153 | 154 | wattroff(window, COLOR_PAIR(BLACK_BLUE)); 155 | } 156 | } 157 | 158 | void Editor::insert_char(wchar_t chr) { 159 | // TODO: needs refactor! 160 | // doesn't support utf-8 yet 161 | 162 | std::wstring _chr = std::wstring(1, chr); 163 | std::wstring &line = file.get(config.cursor_y); 164 | 165 | line.insert(config.cursor_x, _chr); 166 | 167 | config.cursor_x++; 168 | } 169 | 170 | void Editor::remove_char(bool reversed = false) { 171 | std::wstring &line = file.get(config.cursor_y); 172 | // backspace can't remove char if cursor_x is at the beginning 173 | // delete can't remove char if cursor_x is at the end 174 | if ((config.cursor_x == 0 && config.cursor_y == 0 && reversed == false) || 175 | (config.cursor_x == line.size() && config.cursor_y == file.size() - 1 && 176 | reversed == true)) 177 | return; 178 | 179 | // if cursor is at the beginning of the line and that's not the only line 180 | // remove that 181 | if (config.cursor_x == 0 && reversed == false) { 182 | size_t x = file.jointo_prevline(config.cursor_y); 183 | config.cursor_y--; 184 | config.cursor_x = x; 185 | return; 186 | } 187 | 188 | // if cursor is at the end of a line and there's at least one more line after 189 | // that, we must remove next line and append that to the current line 190 | if (config.cursor_x == line.size() && reversed == true) { 191 | file.jointo_nextline(config.cursor_y); 192 | return; 193 | } 194 | 195 | // seek to cursor_x position 196 | std::wstring::iterator it = line.begin() + config.cursor_x; 197 | 198 | // backspace will remove the previous char 199 | if (reversed == false) { 200 | it--; // seek to previous position 201 | config.cursor_x--; // change cursor position 202 | } 203 | 204 | line.erase(it); 205 | } 206 | 207 | void Editor::insert_newline() { 208 | file.newline_after(config.cursor_y, config.cursor_x); 209 | // change cursor positions (beginning of the next line) 210 | config.cursor_y++; 211 | config.cursor_x = 0; 212 | } 213 | 214 | void Editor::process_key() { 215 | /* wchar_t chr = wgetch(window); // read key */ 216 | wint_t ichar; 217 | wget_wch(window, &ichar); 218 | wchar_t chr = (wchar_t)ichar; 219 | 220 | switch (chr) { 221 | case CTRL_KEY(_KEY_QUIT): 222 | // exit normally 223 | exit(0); 224 | 225 | case CTRL_KEY(_KEY_SAVE): 226 | this->file.save(); 227 | return; 228 | 229 | case KEY_RESIZE: 230 | // resize 231 | _win_resize(); 232 | return; 233 | 234 | case KEY_UP: 235 | case KEY_DOWN: 236 | case KEY_LEFT: 237 | case KEY_RIGHT: 238 | case KEY_NPAGE: 239 | case KEY_PPAGE: 240 | _move_cursor(chr); 241 | return; 242 | } 243 | 244 | // if no file is opened, other functionalities must not working 245 | if (this->file.is_empty()) 246 | return; 247 | 248 | switch (chr) { 249 | case KEY_BACKSPACE: 250 | remove_char(); 251 | return; 252 | 253 | case KEY_DC: // this is delete key 254 | remove_char(true); // reversed removation = true 255 | return; 256 | 257 | case KEY_RETURN: 258 | insert_newline(); 259 | return; 260 | 261 | case KEY_ESC: 262 | return; 263 | 264 | default: 265 | // TODO: just for now! 266 | insert_char(chr); 267 | } 268 | } 269 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | --------------------------------------------------------------------------------