colorschemes.txt « doc - ranger - mirror of ranger

blob: 905c7a3ecea2742cc76b33d121f68ff81eb3da06 (plain) (tree)

a8f9cf2c ^

efdc7b16 ^

a8f9cf2c ^

efdc7b16 ^

a8f9cf2c ^

efdc7b16 ^

a8f9cf2c ^

efdc7b16 ^

9a735f62 ^

efdc7b16 ^

a8f9cf2c ^

generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-07-05 14:17:57 +0000

rner cases. The premise is //: that understandability and rewrite-friendliness are related in a virtuous //: cycle. Doing one well makes it easier to do the other. //: //: Lower down, this file contains a legal, bare-bones C++ program. It doesn't //: do anything yet; subsequent files will contain :(...) directives to insert //: lines into it. For example: //: :(after "more events") //: This directive means: insert the following lines after a line in the //: program containing the words "more events". //: //: A simple tool is included to 'tangle' all the files together in sequence //: according to their directives into a single source file containing all the //: code for the project, and then feed the source file to the compiler. //: (It'll drop these comments starting with a '//:' prefix that only make //: sense before tangling.) //: //: Directives free up the programmer to order code for others to read rather //: than as forced by the computer or compiler. Each individual feature can be //: organized in a self-contained 'layer' that adds code to many different data //: structures and functions all over the program. The right decomposition into //: layers will let each layer make sense in isolation. //: //: "If I look at any small part of it, I can see what is going on -- I don't //: need to refer to other parts to understand what something is doing. //: //: If I look at any large part in overview, I can see what is going on -- I //: don't need to know all the details to get it. //: //: Every level of detail is as locally coherent and as well thought-out as //: any other level." //: //: -- Richard Gabriel, "The Quality Without A Name" //: (<a href="http://dreamsongs.com/Files/PatternsOfSoftware.pdf">http://dreamsongs.com/Files/PatternsOfSoftware.pdf</a>, page 42) //: //: Directives are powerful; they permit inserting or modifying any point in //: the program. Using them tastefully requires mapping out specific lines as //: waypoints for future layers to hook into. Often such waypoints will be in //: comments, capitalized to hint that other layers rely on their presence. //: //: A single waypoint might have many different code fragments hooking into //: it from all over the codebase. Use 'before' directives to insert //: code at a location in order, top to bottom, and 'after' directives to //: insert code in reverse order. By convention waypoints intended for insertion //: before begin with 'End'. Notice below how the layers line up above the "End //: Foo" waypoint. //: //: File 001 File 002 File 003 //: ============ =================== =================== //: // Foo //: ------------ //: <---- :(before "End Foo") //: .... //: ... //: ------------ //: <---------------------------- :(before "End Foo") //: .... //: ... //: // End Foo //: ============ //: //: Here's part of a layer in color: <a href="http://i.imgur.com/0eONnyX.png">http://i.imgur.com/0eONnyX.png</a>. Directives //: are shaded dark. //: //: Layers do more than just shuffle code around. In a well-organized codebase //: it should be possible to stop loading after any file/layer, build and run //: the program, and pass all tests for loaded features. (Relevant is //: <a href="http://youtube.com/watch?v=c8N72t7aScY">http://youtube.com/watch?v=c8N72t7aScY</a>, a scene from "2001: A Space //: Odyssey".) Get into the habit of running the included script called //: 'test_layers' before you commit any changes. //: //: This 'subsetting guarantee' ensures that this directory contains a //: cleaned-up narrative of the evolution of this codebase. Organizing //: autobiographically allows a newcomer to rapidly orient himself, reading the //: first few files to understand a simple gestalt of a program's core purpose //: and features, and later gradually working his way through other features as //: the need arises. //: //: Programmers shouldn't need to understand everything about a program to hack //: on it. But they shouldn't be prevented from a thorough understanding of //: each aspect either. The goal of layers is to reward curiosity. // Includes // End Includes // Types // End Types // Prototypes are auto-generated in the makefile; define your functions in any // order. Just be sure to declare each function header all on one line. Our // auto-generation scripts are too minimal and simple-minded to handle // anything else. #include "function_list" // by convention, files ending with '_list' are auto-generated // Globals // // All statements in this section should always define a single variable on a // single line. The makefile will simple-mindedly auto-generate extern // declarations for them. Don't forget to define (not just declare) constants // with extern linkage in this section, since C++ global constants have // internal linkage by default. // // End Globals int main(int argc, char* argv[]) { atexit(teardown); // End One-time Setup // Commandline Parsing // End Commandline Parsing return 0; // End Main } // Unit Tests // End Unit Tests //: our first directive; will move the include above the program :(before "End Includes") #include <stdlib.h> //: Without directives or with the :(code) directive, lines get added at the //: end. :(code) void setup() { // End Setup } void teardown() { // End Teardown } </pre> </body> </html>