diff --git a/amd.html.markdown b/amd.html.markdown index d7fb41ba..fc8f20a4 100644 --- a/amd.html.markdown +++ b/amd.html.markdown @@ -1,212 +1,212 @@ ---- -category: tool -tool: amd -contributors: - - ["Frederik Ring", "https://github.com/m90"] -filename: learnamd.js ---- - -## Getting Started with AMD - -The **Asynchronous Module Definition** API specifies a mechanism for defining -JavaScript modules such that the module and its dependencies can be asynchronously -loaded. This is particularly well suited for the browser environment where -synchronous loading of modules incurs performance, usability, debugging, and -cross-domain access problems. - -### Basic concept -```javascript -// The basic AMD API consists of nothing but two methods: `define` and `require` -// and is all about module definition and consumption: -// `define(id?, dependencies?, factory)` defines a module -// `require(dependencies, callback)` imports a set of dependencies and -// consumes them in the passed callback - -// Let's start by using define to define a new named module -// that has no dependencies. We'll do so by passing a name -// and a factory function to define: -define('awesomeAMD', function(){ - var isAMDAwesome = function(){ - return true; - }; - // The return value of a module's factory function is - // what other modules or require calls will receive when - // requiring our `awesomeAMD` module. - // The exported value can be anything, (constructor) functions, - // objects, primitives, even undefined (although that won't help too much). - return isAMDAwesome; -}); - -// Now, let's define another module that depends upon our `awesomeAMD` module. -// Notice that there's an additional argument defining our -// module's dependencies now: -define('loudmouth', ['awesomeAMD'], function(awesomeAMD){ - // dependencies will be passed to the factory's arguments - // in the order they are specified - var tellEveryone = function(){ - if (awesomeAMD()){ - alert('This is sOoOo rad!'); - } else { - alert('Pretty dull, isn\'t it?'); - } - }; - return tellEveryone; -}); - -// As we do know how to use define now, let's use `require` to -// kick off our program. `require`'s signature is `(arrayOfDependencies, callback)`. -require(['loudmouth'], function(loudmouth){ - loudmouth(); -}); - -// To make this tutorial run code, let's implement a very basic -// (non-asynchronous) version of AMD right here on the spot: -function define(name, deps, factory){ - // notice how modules without dependencies are handled - define[name] = require(factory ? deps : [], factory || deps); -} - -function require(deps, callback){ - var args = []; - // first let's retrieve all the dependencies needed - // by the require call - for (var i = 0; i < deps.length; i++){ - args[i] = define[deps[i]]; - } - // satisfy all the callback's dependencies - return callback.apply(null, args); -} -// you can see this code in action here: http://jsfiddle.net/qap949pd/ -``` - -### Real-world usage with require.js - -In contrast to the introductory example, `require.js` (the most popular AMD library) actually implements the **A** in **AMD**, enabling you to load modules and their dependencies asynchronously via XHR: - -```javascript -/* file: app/main.js */ -require(['modules/someClass'], function(SomeClass){ - // the callback is deferred until the dependency is loaded - var thing = new SomeClass(); -}); -console.log('So here we are, waiting!'); // this will run first -``` - -By convention, you usually store one module in one file. `require.js` can resolve module names based on file paths, so you don't have to name your modules, but can simply reference them using their location. In the example `someClass` is assumed to be in the `modules` folder, relative to your configuration's `baseUrl`: - -* app/ - * main.js - * modules/ - * someClass.js - * someHelpers.js - * ... - * daos/ - * things.js - * ... - -This means we can define `someClass` without specifying a module id: - -```javascript -/* file: app/modules/someClass.js */ -define(['daos/things', 'modules/someHelpers'], function(thingsDao, helpers){ - // module definition, of course, will also happen asynchronously - function SomeClass(){ - this.method = function(){/**/}; - // ... - } - return SomeClass; -}); -``` -To alter the default path mapping behavior use `requirejs.config(configObj)` in your `main.js`: - -```javascript -/* file: main.js */ -requirejs.config({ - baseUrl : 'app', - paths : { - // you can also load modules from other locations - jquery : '//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min', - coolLibFromBower : '../bower_components/cool-lib/coollib' - } -}); -require(['jquery', 'coolLibFromBower', 'modules/someHelpers'], function($, coolLib, helpers){ - // a `main` file needs to call require at least once, - // otherwise no code will ever run - coolLib.doFancyStuffWith(helpers.transform($('#foo'))); -}); -``` -`require.js`-based apps will usually have a single entry point (`main.js`) that is passed to the `require.js` script tag as a data-attribute. It will be automatically loaded and executed on pageload: - -```html - - - - A hundred script tags? Never again! - - - - - -``` - -### Optimizing a whole project using r.js - -Many people prefer using AMD for sane code organization during development, but still want to ship a single script file in production instead of performing hundreds of XHRs on page load. - -`require.js` comes with a script called `r.js` (that you will probably run in node.js, although Rhino is supported too) that can analyse your project's dependency graph, and build a single file containing all your modules (properly named), minified and ready for consumption. - -Install it using `npm`: -```shell -$ npm install requirejs -g -``` - -Now you can feed it with a configuration file: -```shell -$ r.js -o app.build.js -``` - -For our above example the configuration might look like: -```javascript -/* file : app.build.js */ -({ - name : 'main', // name of the entry point - out : 'main-built.js', // name of the file to write the output to - baseUrl : 'app', - paths : { - // `empty:` tells r.js that this should still be loaded from the CDN, using - // the location specified in `main.js` - jquery : 'empty:', - coolLibFromBower : '../bower_components/cool-lib/coollib' - } -}) -``` - -To use the built file in production, simply swap `data-main`: -```html - -``` - -An incredibly detailed [overview of build options](https://github.com/jrburke/r.js/blob/master/build/example.build.js) is available in the GitHub repo. - -### Topics not covered in this tutorial -* [Loader plugins / transforms](http://requirejs.org/docs/plugins.html) -* [CommonJS style loading and exporting](http://requirejs.org/docs/commonjs.html) -* [Advanced configuration](http://requirejs.org/docs/api.html#config) -* [Shim configuration (loading non-AMD modules)](http://requirejs.org/docs/api.html#config-shim) -* [CSS loading and optimizing with require.js](http://requirejs.org/docs/optimization.html#onecss) -* [Using almond.js for builds](https://github.com/jrburke/almond) - -### Further reading: - -* [Official Spec](https://github.com/amdjs/amdjs-api/wiki/AMD) -* [Why AMD?](http://requirejs.org/docs/whyamd.html) -* [Universal Module Definition](https://github.com/umdjs/umd) - -### Implementations: - -* [require.js](http://requirejs.org) -* [dojo toolkit](http://dojotoolkit.org/documentation/tutorials/1.9/modules/) -* [cujo.js](http://cujojs.com/) -* [curl.js](https://github.com/cujojs/curl) -* [lsjs](https://github.com/zazl/lsjs) -* [mmd](https://github.com/alexlawrence/mmd) +--- +category: tool +tool: amd +contributors: + - ["Frederik Ring", "https://github.com/m90"] +filename: learnamd.js +--- + +## Getting Started with AMD + +The **Asynchronous Module Definition** API specifies a mechanism for defining +JavaScript modules such that the module and its dependencies can be asynchronously +loaded. This is particularly well suited for the browser environment where +synchronous loading of modules incurs performance, usability, debugging, and +cross-domain access problems. + +### Basic concept +```javascript +// The basic AMD API consists of nothing but two methods: `define` and `require` +// and is all about module definition and consumption: +// `define(id?, dependencies?, factory)` defines a module +// `require(dependencies, callback)` imports a set of dependencies and +// consumes them in the passed callback + +// Let's start by using define to define a new named module +// that has no dependencies. We'll do so by passing a name +// and a factory function to define: +define('awesomeAMD', function(){ + var isAMDAwesome = function(){ + return true; + }; + // The return value of a module's factory function is + // what other modules or require calls will receive when + // requiring our `awesomeAMD` module. + // The exported value can be anything, (constructor) functions, + // objects, primitives, even undefined (although that won't help too much). + return isAMDAwesome; +}); + +// Now, let's define another module that depends upon our `awesomeAMD` module. +// Notice that there's an additional argument defining our +// module's dependencies now: +define('loudmouth', ['awesomeAMD'], function(awesomeAMD){ + // dependencies will be passed to the factory's arguments + // in the order they are specified + var tellEveryone = function(){ + if (awesomeAMD()){ + alert('This is sOoOo rad!'); + } else { + alert('Pretty dull, isn\'t it?'); + } + }; + return tellEveryone; +}); + +// As we do know how to use define now, let's use `require` to +// kick off our program. `require`'s signature is `(arrayOfDependencies, callback)`. +require(['loudmouth'], function(loudmouth){ + loudmouth(); +}); + +// To make this tutorial run code, let's implement a very basic +// (non-asynchronous) version of AMD right here on the spot: +function define(name, deps, factory){ + // notice how modules without dependencies are handled + define[name] = require(factory ? deps : [], factory || deps); +} + +function require(deps, callback){ + var args = []; + // first let's retrieve all the dependencies needed + // by the require call + for (var i = 0; i < deps.length; i++){ + args[i] = define[deps[i]]; + } + // satisfy all the callback's dependencies + return callback.apply(null, args); +} +// you can see this code in action here: http://jsfiddle.net/qap949pd/ +``` + +### Real-world usage with require.js + +In contrast to the introductory example, `require.js` (the most popular AMD library) actually implements the **A** in **AMD**, enabling you to load modules and their dependencies asynchronously via XHR: + +```javascript +/* file: app/main.js */ +require(['modules/someClass'], function(SomeClass){ + // the callback is deferred until the dependency is loaded + var thing = new SomeClass(); +}); +console.log('So here we are, waiting!'); // this will run first +``` + +By convention, you usually store one module in one file. `require.js` can resolve module names based on file paths, so you don't have to name your modules, but can simply reference them using their location. In the example `someClass` is assumed to be in the `modules` folder, relative to your configuration's `baseUrl`: + +* app/ + * main.js + * modules/ + * someClass.js + * someHelpers.js + * ... + * daos/ + * things.js + * ... + +This means we can define `someClass` without specifying a module id: + +```javascript +/* file: app/modules/someClass.js */ +define(['daos/things', 'modules/someHelpers'], function(thingsDao, helpers){ + // module definition, of course, will also happen asynchronously + function SomeClass(){ + this.method = function(){/**/}; + // ... + } + return SomeClass; +}); +``` +To alter the default path mapping behavior use `requirejs.config(configObj)` in your `main.js`: + +```javascript +/* file: main.js */ +requirejs.config({ + baseUrl : 'app', + paths : { + // you can also load modules from other locations + jquery : '//ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min', + coolLibFromBower : '../bower_components/cool-lib/coollib' + } +}); +require(['jquery', 'coolLibFromBower', 'modules/someHelpers'], function($, coolLib, helpers){ + // a `main` file needs to call require at least once, + // otherwise no code will ever run + coolLib.doFancyStuffWith(helpers.transform($('#foo'))); +}); +``` +`require.js`-based apps will usually have a single entry point (`main.js`) that is passed to the `require.js` script tag as a data-attribute. It will be automatically loaded and executed on pageload: + +```html + + + + A hundred script tags? Never again! + + + + + +``` + +### Optimizing a whole project using r.js + +Many people prefer using AMD for sane code organization during development, but still want to ship a single script file in production instead of performing hundreds of XHRs on page load. + +`require.js` comes with a script called `r.js` (that you will probably run in node.js, although Rhino is supported too) that can analyse your project's dependency graph, and build a single file containing all your modules (properly named), minified and ready for consumption. + +Install it using `npm`: +```shell +$ npm install requirejs -g +``` + +Now you can feed it with a configuration file: +```shell +$ r.js -o app.build.js +``` + +For our above example the configuration might look like: +```javascript +/* file : app.build.js */ +({ + name : 'main', // name of the entry point + out : 'main-built.js', // name of the file to write the output to + baseUrl : 'app', + paths : { + // `empty:` tells r.js that this should still be loaded from the CDN, using + // the location specified in `main.js` + jquery : 'empty:', + coolLibFromBower : '../bower_components/cool-lib/coollib' + } +}) +``` + +To use the built file in production, simply swap `data-main`: +```html + +``` + +An incredibly detailed [overview of build options](https://github.com/jrburke/r.js/blob/master/build/example.build.js) is available in the GitHub repo. + +### Topics not covered in this tutorial +* [Loader plugins / transforms](http://requirejs.org/docs/plugins.html) +* [CommonJS style loading and exporting](http://requirejs.org/docs/commonjs.html) +* [Advanced configuration](http://requirejs.org/docs/api.html#config) +* [Shim configuration (loading non-AMD modules)](http://requirejs.org/docs/api.html#config-shim) +* [CSS loading and optimizing with require.js](http://requirejs.org/docs/optimization.html#onecss) +* [Using almond.js for builds](https://github.com/jrburke/almond) + +### Further reading: + +* [Official Spec](https://github.com/amdjs/amdjs-api/wiki/AMD) +* [Why AMD?](http://requirejs.org/docs/whyamd.html) +* [Universal Module Definition](https://github.com/umdjs/umd) + +### Implementations: + +* [require.js](http://requirejs.org) +* [dojo toolkit](http://dojotoolkit.org/documentation/tutorials/1.9/modules/) +* [cujo.js](http://cujojs.com/) +* [curl.js](https://github.com/cujojs/curl) +* [lsjs](https://github.com/zazl/lsjs) +* [mmd](https://github.com/alexlawrence/mmd) diff --git a/de-de/csharp-de.html.markdown b/de-de/csharp-de.html.markdown index 18a23017..662c2e76 100644 --- a/de-de/csharp-de.html.markdown +++ b/de-de/csharp-de.html.markdown @@ -1,890 +1,890 @@ ---- -language: C# -contributors: - - ["Irfan Charania", "https://github.com/irfancharania"] - - ["Max Yankov", "https://github.com/golergka"] - - ["Melvyn Laïly", "http://x2a.yt"] - - ["Shaun McCarthy", "http://www.shaunmccarthy.com"] -translators: - - ["Frederik Ring", "https://github.com/m90"] -filename: LearnCSharp-de.cs -lang: de-de ---- -C# ist eine elegante, typsichere und objektorientierte Sprache, mit der Entwickler eine Vielzahl sicherer und robuster Anwendungen erstellen können, die im .NET Framework ausgeführt werden. - -[Mehr über C# erfährst du hier.](http://msdn.microsoft.com/de-de/library/vstudio/z1zx9t92.aspx) - -```c# -// Einzeilige Kommentare starten mit zwei Schrägstrichen: // -/* -Mehrzeile Kommentare wie in C Schrägstrich / Stern -*/ -/// -/// XML-Kommentare können zur automatisierten Dokumentation verwendet werden -/// - -// Zu Beginn werden die in der Datei verwendeten Namespaces aufgeführt -using System; -using System.Collections.Generic; -using System.Data.Entity; -using System.Dynamic; -using System.Linq; -using System.Linq.Expressions; -using System.Net; -using System.Threading.Tasks; -using System.IO; - -// definiert einen Namespace um Code in "packages" zu organisieren -namespace Learning -{ - // Jede .cs-Datei sollte zumindest eine Klasse mit dem Namen der Datei - // enthalten. Das ist zwar nicht zwingend erforderlich, es anders zu - // handhaben führt aber unweigerlich ins Chaos (wirklich)! - public class LearnCSharp - { - // Zuerst erklärt dieses Tutorial die Syntax-Grundlagen, - // wenn du bereits Java oder C++ programmieren kannst: - // lies bei "Interessante Features" weiter! - public static void Syntax() - { - // Mit Console.WriteLine kannst du einfachen Text ausgeben: - Console.WriteLine("Hallo Welt"); - Console.WriteLine( - "Integer: " + 10 + - " Double: " + 3.14 + - " Boolean: " + true); - - // Console.Write erzeugt keinen Zeilenumbruch - Console.Write("Hallo "); - Console.Write("Welt"); - - /////////////////////////////////////////////////// - // Typen & Variablen - /////////////////////////////////////////////////// - - // Deklariere eine Variable mit - - // Sbyte - Vorzeichenbehaftete 8-Bit Ganzzahl - // (-128 <= sbyte <= 127) - sbyte fooSbyte = 100; - - // Byte - Vorzeichenlose 8-Bit Ganzzahl - // (0 <= byte <= 255) - byte fooByte = 100; - - // Short - 16-Bit Ganzzahl - // Vorzeichenbehaftet - (-32,768 <= short <= 32,767) - // Vorzeichenlos - (0 <= ushort <= 65,535) - short fooShort = 10000; - ushort fooUshort = 10000; - - // Integer - 32-bit Ganzzahl - int fooInt = 1; // (-2,147,483,648 <= int <= 2,147,483,647) - uint fooUint = 1; // (0 <= uint <= 4,294,967,295) - - // Long - 64-bit Ganzzahl - long fooLong = 100000L; // (-9,223,372,036,854,775,808 <= long <= 9,223,372,036,854,775,807) - ulong fooUlong = 100000L; // (0 <= ulong <= 18,446,744,073,709,551,615) - // Ganze Zahlen werden standardmäßig - je nach Größe - als int oder - // uint behandelt. Ein nachgestelltes L markiert den Wert als long - // oder ulong. - - // Double - Double-precision 64-bit IEEE 754 Fließkommazahl - double fooDouble = 123.4; // Genauigkeit: 15-16 Stellen - - // Float - Single-precision 32-bit IEEE 754 Fließkommazahl - float fooFloat = 234.5f; // Genauigkeit: 7 Stellen - // Das nachgestellte f zeigt an dass es sich um einen Wert vom Typ - // float handelt - - // Decimal - ein 128-Bit-Datentyp mit größerer Genauigkeit als - // andere Fließkommatypen, und somit bestens geeignet für - // die Berechnung von Geld- und Finanzwerten - decimal fooDecimal = 150.3m; - - // Boolean - true & false - bool fooBoolean = true; // oder false - - // Char - Ein einzelnes 16-Bit Unicode Zeichen - char fooChar = 'A'; - - // Strings - im Gegensatz zu allen vorhergehenden Basistypen, die - // alle Werttypen sind, ist String ein Referenztyp. Strings sind - // somit nullable, Werttypen sind dies nicht. - string fooString = "\"maskiere\" Anführungszeichen, und füge \n (Umbrüche) und \t (Tabs) hinzu"; - Console.WriteLine(fooString); - - // Jeder Buchstabe eines Strings kann über seinen Index - // referenziert werden: - char charFromString = fooString[1]; // => 'e' - // Strings sind unveränderlich: - // `fooString[1] = 'X';` funktioniert nicht - - // Ein Vergleich zweier Strings, unter Berücksichtigung der - // aktuellen, sprachspezifischen Gegebenheiten (also z.B. a,ä,b,c - // in deutschsprachigen Umgebungen), und ohne Beachtung von - // Groß- und Kleinschreibung: - string.Compare(fooString, "x", StringComparison.CurrentCultureIgnoreCase); - - // Formatierung, genau wie "sprintf" - string fooFs = string.Format("Mikrofon Check, {0} {1}, {0} {1:0.0}", 1, 2); - - // Datumsangaben und Formatierung - DateTime fooDate = DateTime.Now; - Console.WriteLine(fooDate.ToString("hh:mm, dd MMM yyyy")); - - // Durch ein vorangestelltes @ lässt sich ein mehrzeiliger String - // schreiben. Um " zu maskieren benutzt man "" - string bazString = @"Hier geht es -zur nächsten Zeile, ""Wahnsinn!"", die Massen waren kaum zu bändigen"; - - // Die Keywords const oder readonly kennzeichnen eine - // unveränderliche Variable/Konstante. Die Werte von Konstanten - // werden übrigens bereits zur Compile-Zeit berechnet. - const int HOURS_I_WORK_PER_WEEK = 9001; - - /////////////////////////////////////////////////// - // Datenstrukturen - /////////////////////////////////////////////////// - - // Arrays - Index beginnt bei Null - // Die Größe des Arrays wird bei der Deklaration festgelegt. - // Die syntaktische Struktur um ein neues Array zu erzeugen sieht - // folgendermaßen aus: - // [] = new []; - int[] intArray = new int[10]; - - // Arrays können auch über ein Array-Literal deklariert werden: - int[] y = { 9000, 1000, 1337 }; - - // Indizierung eines Arrays - Zugriff auf ein bestimmtes Element - Console.WriteLine("intArray @ 0: " + intArray[0]); - // Arrays sind veränderbar - intArray[1] = 1; - - // Listen - // Durch ihre größere Flexibilität kommen Listen in C# weit - // häufiger zum Einsatz als Arrays. Eine Liste wird so deklariert: - // List = new List(); - List intList = new List(); - List stringList = new List(); - List z = new List { 9000, 1000, 1337 }; - // Die <> kennzeichnen "Generics", mehr dazu unter "Coole Sachen" - - // Listen haben keinen Default-Wert. - // Bevor auf einen Index zugegriffen werden kann, muss dieser - // auch gesetzt worden sein: - intList.Add(1); - Console.WriteLine("intList @ 0: " + intList[0]); - - // Andere interessante Datenstrukturen sind: - // Stack/Queue - // Dictionary (entspricht einer Hash Map) - // HashSet - // Read-only Collections - // Tuple (.Net 4+) - - /////////////////////////////////////// - // Operatoren - /////////////////////////////////////// - Console.WriteLine("\n->Operatoren"); - - // kurze Schreibweise um mehrere Deklarationen zusammenzufassen: - // (Benutzung vom C# Styleguide aber ausdrücklich abgeraten!) - int i1 = 1, i2 = 2; - - // Arithmetik funktioniert wie erwartet: - Console.WriteLine(i1 + i2 - i1 * 3 / 7); // => 3 - - // Modulo - Console.WriteLine("11%3 = " + (11 % 3)); // => 2 - - // Vergleiche - Console.WriteLine("3 == 2? " + (3 == 2)); // => false - Console.WriteLine("3 != 2? " + (3 != 2)); // => true - Console.WriteLine("3 > 2? " + (3 > 2)); // => true - Console.WriteLine("3 < 2? " + (3 < 2)); // => false - Console.WriteLine("2 <= 2? " + (2 <= 2)); // => true - Console.WriteLine("2 >= 2? " + (2 >= 2)); // => true - - // Bitweise Operatoren - /* - ~ Unäres bitweises NICHT - << Verschieben nach links - >> Verschieben nach rechts - & Bitweises UND - ^ Bitweises exklusives ODER - | Bitweises inklusives ODER - */ - - // Inkremente - int i = 0; - Console.WriteLine("\n->Inkrement / Dekrement"); - Console.WriteLine(i++); //i = 1. Post-Inkrement - Console.WriteLine(++i); //i = 2. Pre-Inkrement - Console.WriteLine(i--); //i = 1. Post-Dekrement - Console.WriteLine(--i); //i = 0. Pre-Dekrement - - /////////////////////////////////////// - // Kontrollstrukturen - /////////////////////////////////////// - Console.WriteLine("\n->Kontrollstrukturen"); - - // If-Statements funktionieren wie in C - int j = 10; - if (j == 10) - { - Console.WriteLine("Ich werde ausgegeben"); - } - else if (j > 10) - { - Console.WriteLine("Ich nicht"); - } - else - { - Console.WriteLine("Ich leider auch nicht"); - } - - // Ternärer Operator - // Anstatt eines einfachen if/else lässt sich auch folgendes schreiben: - // ? : - int zumVergleich = 17; - string isTrue = zumVergleich == 17 ? "Ja" : "Nein"; - - // while-Schleife - int fooWhile = 0; - while (fooWhile < 100) - { - // Wird 100mal wiederholt, fooWhile 0->99 - fooWhile++; - } - - // do-while-Schleife - int fooDoWhile = 0; - do - { - // Wird 100mal wiederholt, fooDoWhile 0->99 - fooDoWhile++; - } while (fooDoWhile < 100); - - //for-Schleifen => for(; ; ) - for (int fooFor = 0; fooFor < 10; fooFor++) - { - // Wird 10mal wiederholt, fooFor 0->9 - } - - // foreach-Schleife - // Die normale Syntax für eine foreach-Schleife lautet: - // foreach( in ) - // foreach kann mit jedem Objekt verwendet werden das IEnumerable - // oder IEnumerable implementiert. Alle Auflistungs-Typen - // (Array, List, Dictionary...) im .NET Framework implementieren - // eines dieser beiden Interfaces. - - foreach (char character in "Hallo Welt".ToCharArray()) - { - // Ein Durchgang für jedes Zeichen im String - } - // (ToCharArray() könnte man hier übrigens auch weglassen, - // da String IEnumerable bereits implementiert) - - // Switch Struktur - // Ein Switch funktioniert mit byte, short, char und int Datentypen. - // Auch Aufzählungstypen können verwendet werden, genau wie - // die Klasse String, und ein paar Sonderklassen, die Wrapper für - // Primitives sind: Character, Byte, Short und Integer - int month = 3; - string monthString; - switch (month) - { - case 1: - monthString = "Januar"; - break; - case 2: - monthString = "Februar"; - break; - case 3: - monthString = "März"; - break; - // Man kann für mehrere Fälle auch das selbe Verhalten - // definieren. Jeder Block muss aber mit einem break-Statement - // abgeschlossen werden. Einzelne Fälle können über - // `goto case x` erreicht werden - case 6: - case 7: - case 8: - monthString = "Sommer!!"; - break; - default: - monthString = "Irgendein anderer Monat"; - break; - } - - /////////////////////////////////////// - // Umwandlung von Datentypen und Typecasting - /////////////////////////////////////// - - // Umwandlung - - // von String nach Integer - // bei einem Fehler wirft diese Code eine Exception - int.Parse("123"); //gibt die Ganzzahl 123 zurück - - // TryParse gibt bei einem Fehler den Default-Wert zurück - // (im Fall von int: 0) - int tryInt; - if (int.TryParse("123", out tryInt)) // gibt true oder false zurück - { - Console.WriteLine(tryInt); // 123 - } - - // von Integer nach String - // Die Klasse Convert stellt Methoden zur Konvertierung von - // unterschiedlichsten Daten zur Verfügung: - Convert.ToString(123); // "123" - // oder - tryInt.ToString(); // "123" - } - - /////////////////////////////////////// - // Klassen - /////////////////////////////////////// - public static void Classes() - { - - // Benutze das new-Keyword um eine Instanz einer Klasse zu erzeugen - Bicycle trek = new Bicycle(); - - // So werden Methoden der Instanz aufgerufen - trek.SpeedUp(3); // Es empfiehlt sich immer Getter und Setter zu benutzen - trek.Cadence = 100; - - // ToString ist eine Konvention über die man üblicherweiser - // Informationen über eine Instanz erhält - Console.WriteLine("Infos zu trek: " + trek.ToString()); - - // Wir instantiieren ein neues Hochrad - PennyFarthing funbike = new PennyFarthing(1, 10); - Console.WriteLine("Infos zu funbike: " + funbike.ToString()); - - Console.Read(); - } // Ende der Methode main - - // Main als Konsolenstartpunkt - // Eine Konsolenanwendung muss eine Methode Main als Startpunkt besitzen - public static void Main(string[] args) - { - OtherInterestingFeatures(); - } - - /////////////////////////////////////// - // Interessante Features - /////////////////////////////////////// - - // Methodensignaturen - - public // Sichtbarkeit - static // Erlaubt einen Zugriff auf der Klasse (nicht auf einer Instanz) - int // Typ des Rückgabewerts, - MethodSignatures( - // Erstes Argument, erwartet int - int maxCount, - // setzt sich selbst auf 0 wenn kein anderer Wert übergeben wird - int count = 0, - int another = 3, - // enthält alle weiteren der Methode übergebenen Parameter (quasi Splats) - params string[] otherParams - ) - { - return -1; - } - - // Methoden können überladen werden, solange sie eindeutige - // Signaturen haben - public static void MethodSignatures(string maxCount) - { - } - - // Generische Typen - // Die Typen für TKey und TValue werden erst beim Aufruf der Methode - // festgelegt. Diese Methode emuliert z.B. SetDefault aus Python: - public static TValue SetDefault( - IDictionary dictionary, - TKey key, - TValue defaultItem) - { - TValue result; - if (!dictionary.TryGetValue(key, out result)) - { - return dictionary[key] = defaultItem; - } - return result; - } - - // Möglichen Typen lassen sich auch über ihr Interface beschränken: - public static void IterateAndPrint(T toPrint) where T: IEnumerable - { - // Da T ein IEnumerable ist können wir foreach benutzen - foreach (var item in toPrint) - { - // Item ist ein int - Console.WriteLine(item.ToString()); - } - } - - public static void OtherInterestingFeatures() - { - // Optionale Parameter - MethodSignatures(3, 1, 3, "Ein paar", "extra", "Strings"); - // setzt explizit einen bestimmten Parameter, andere werden übersprungen - MethodSignatures(3, another: 3); - - // Erweiterungsmethoden - int i = 3; - i.Print(); // Weiter unten definiert - - // Nullables - perfekt für die Interaktion mit - // Datenbanken / Rückgabewerten - // Jeder Wert (d.h. keine Klassen) kann durch das Nachstellen eines ? - // nullable gemacht werden: ? = - int? nullable = null; // Die explizite Langform wäre Nullable - Console.WriteLine("Mein Nullable: " + nullable); - bool hasValue = nullable.HasValue; // true wenn nicht null - - // ?? ist "syntaktischer Zucker" um einen Defaultwert für den Fall - // dass die Variable null ist festzulegen. - int notNullable = nullable ?? 0; // 0 - - // Implizit typisierte Variablen - // Man kann auch den Typ einer Variable auch vom Compiler - // bestimmen lassen: - var magic = "magic ist zur Compile-Zeit ein String, folglich geht keine Typsicherheit verloren"; - magic = 9; // funktioniert nicht da magic vom Typ String ist - - // Generics - var phonebook = new Dictionary() { - {"Resi", "08822 / 43 67"} // Fügt einen Eintrag zum Telefonbuch hinzu - }; - - // Hier könnte man auch unser generisches SetDefault von - // weiter oben benutzen: - Console.WriteLine(SetDefault(phonebook, "Xaver", "kein Telefon")); // kein Telefon - // TKey und TValue müssen nicht zwingend angegeben werden, da sie - // auch implizit vom Compiler ermittelt werden können - Console.WriteLine(SetDefault(phonebook, "Resi", "kein Telefon")); // 08822 / 43 67 - - // Lambdas - konzise Syntax für Inline-Funktionen - Func square = (x) => x * x; // Das letzte Element vom Typ T ist der Rückgabewert - Console.WriteLine(square(3)); // 9 - - // Disposables - einfaches Management von nicht verwalteten Ressourcen - // So gut wie alle Objekte die auf nicht verwaltete Ressourcen - // (Dateien, Geräte, ...) zugreifen, implementieren das Interface - // IDisposable. Das using Statement stellt sicher dass die vom - // IDisposable benutzten Ressourcen nach der Benutzung wieder - // freigegeben werden: - using (StreamWriter writer = new StreamWriter("log.txt")) - { - writer.WriteLine("Alles bestens!"); - // Am Ende des Codeblocks werden die Ressourcen wieder - // freigegeben - auch im Falle einer Exception - } - - // Parallel Klasse - // http://blogs.msdn.com/b/csharpfaq/archive/2010/06/01/parallel-programming-in-net-framework-4-getting-started.aspx - var websites = new string[] { - "http://www.google.com", "http://www.reddit.com", - "http://www.shaunmccarthy.com" - }; - var responses = new Dictionary(); - - // Für jeden Request wird ein neuer Thread erzeugt, der nächste - // Schritt wird erst nach Beendigung aller Tasks ausgeführt - Parallel.ForEach(websites, - // maximal 3 Threads gleichzeitig - new ParallelOptions() {MaxDegreeOfParallelism = 3}, - website => - { - // Hier folgt eine langwierige, asynchrone Operation - using (var r = WebRequest.Create(new Uri(website)).GetResponse()) - { - responses[website] = r.ContentType; - } - }); - - // Dieser Code wird erst nach Beendigung aller Requests ausgeführt - foreach (var key in responses.Keys) - { - Console.WriteLine("{0}:{1}", key, responses[key]); - } - - // Dynamische Objekte (gut um mit anderen Sprachen zu arbeiten) - dynamic student = new ExpandoObject(); - // hier muss keine Typ angegeben werden - student.FirstName = "Christian"; - - // Einem solchen Objekt kann man sogar Methoden zuordnen. - // Das Beispiel gibt einen String zurück und erwartet einen String - student.Introduce = new Func( - (introduceTo) => string.Format("Hallo {0}, das ist {1}", student.FirstName, introduceTo)); - Console.WriteLine(student.Introduce("Bettina")); - - // IQueryable - So gut wie alle Aufzählungstypen implementieren - // dieses Interface, welches eine Vielzahl von funktionalen Methoden - // wie Map / Filter / Reduce zur Verfügung stellt: - var bikes = new List(); - // sortiert die Liste - bikes.Sort(); - // sortiert nach Anzahl Räder - bikes.Sort((b1, b2) => b1.Wheels.CompareTo(b2.Wheels)); - var result = bikes - // diese Filter können auch aneinandergehängt werden - .Where(b => b.Wheels > 3) // (gibt ein IQueryable des vorherigen Typs zurück) - .Where(b => b.IsBroken && b.HasTassles) - // diese Zuordnung gibt ein IQueryable zurück - .Select(b => b.ToString()); - - // "Reduce" - addiert alle Räder der Aufzählung zu einem Wert - var sum = bikes.Sum(b => b.Wheels); - - // So erzeugt man ein implizit typisiertes Objekt, basierend auf - // den Parametern der Elemente: - var bikeSummaries = bikes.Select(b=>new { Name = b.Name, IsAwesome = !b.IsBroken && b.HasTassles }); - // Auch wenn wir es hier nicht demonstrieren können: - // In einer IDE wie VisualStudio kriegen wir hier sogar TypeAhead, - // da der Compiler in der Lage ist, die passenden Typen zu erkennen. - foreach (var bikeSummary in bikeSummaries.Where(b => b.IsAwesome)) - { - Console.WriteLine(bikeSummary.Name); - } - - // AsParallel-Methode - // Jetzt kommen die Schmankerl! Die AsParallel-Methode kombiniert - // LINQ und parallele Operationen: - var threeWheelers = bikes.AsParallel().Where(b => b.Wheels == 3).Select(b => b.Name); - // Diese Berechnung passiert parallel! Benötigte Threads werden - // automatisch erzeugt, und die Rechenlast unter ihnen aufgeteilt. - // Ein Traum für die Verarbeitung von großen Datenmengen - // auf mehreren Cores! - - // LINQ - bildet einen Datenspeicher auf IQueryable Objekte ab - // LinqToSql beispielsweise speichert und liest aus einer - // SQL-Datenbank, LinqToXml aus einem XML-Dokument. - // LINQ-Operationen werden "lazy" ausgeführt. - var db = new BikeRepository(); - - // Die verzögerte Ausführung ist optimal für Datenbankabfragen - var filter = db.Bikes.Where(b => b.HasTassles); // noch keine Abfrage - // Es können noch mehr Filter hinzugefügt werden (auch mit - // Bedingungen) - ideal für z.B. "erweiterte Suchen" - if (42 > 6) - { - filter = filter.Where(b => b.IsBroken); // immer noch keine Abfrage - } - - var query = filter - .OrderBy(b => b.Wheels) - .ThenBy(b => b.Name) - .Select(b => b.Name); // auch hier: immer noch keine Abfrage - - // Erst hier wird die Datenbankabfrage wirklich ausgeführt, - // limitiert auf die Elemente die der foreach-Loop verwendet - foreach (string bike in query) - { - Console.WriteLine(result); - } - - } - - } // Ende der Klasse LearnCSharp - - // Eine .cs-Datei kann auch mehrere Klassen enthalten - - public static class Extensions - { - // Erweiterungsmethoden - public static void Print(this object obj) - { - Console.WriteLine(obj.ToString()); - } - } - - // Syntax zur Deklaration einer Klasse: - // class { - // // Datenfelder, Konstruktoren und Methoden leben alle - // // innerhalb dieser Deklaration - // } - - public class Bicycle - { - // Felder/Variablen der Klasse "Bicycle" - // Das Keyword public macht das Member von überall zugänglich - public int Cadence - { - get // get definiert eine Methode um die Eigenschaft abzurufen - { - return _cadence; - } - set // set definiert eine Methode um die Eigenschaft zu setzen - { - _cadence = value; // value ist der dem Setter übergebene Wert - } - } - private int _cadence; - - // Das Keyword protected macht das Member nur für die Klasse selbst - // und ihre Subklassen zugänglich - protected virtual int Gear - { - get; // erzeugt eine Eigenschaft für die kein "Zwischenwert" benötigt wird - set; - } - - // Das Keyword internal macht das Member innerhalb der Assembly zugänglich - internal int Wheels - { - get; - private set; // get/set kann auch über Keywords modifiziert werden - } - - int _speed; // Member ohne vorangestellte Keywords sind standardmäßig - // private, sie sind nur innerhalb der Klasse zugänglich. - // Man kann aber natürlich auch das Keyword private benutzen. - private string Name { get; set; } - - // Ein Enum ist ein klar definierter Satz an benannten Konstanten. - // Eigentlich ordnet es diese Konstanten nur bestimmten Werten zu - // (einer int-Zahl, solange nicht anders angegeben). Mögliche Typen für - // die Werte eines Enums sind byte, sbyte, short, ushort, int, uint, - // long, oder ulong. Alle Werte in einem Enum sind eindeutig. - public enum BikeBrand - { - Colnago, - EddyMerckx, - Bianchi = 42, // so kann man den Wert explizit setzen - Kynast // 43 - } - // Nachdem dieser Typ in der Klasse "Bicycle" definiert ist, - // sollte Code ausserhalb der Klasse den Typen als Bicycle.Brand referenzieren - - // Nachdem das Enum deklariert ist, können wir den Typen verwenden: - public BikeBrand Brand; - - // Als static gekennzeichnete Member gehören dem Typ selbst, - // nicht seinen Instanzen. Man kann sie also ohne Referenz zu einem - // Objekt benutzen - // Console.WriteLine("Schon " + Bicycle.BicyclesCreated + " Fahrräder, nur für dieses Tutorial!"); - static public int BicyclesCreated = 0; - - // readonly-Werte werden zur Laufzeit gesetzt - // Ihr Wert kann nur bei ihrer Deklaration, oder in einem Konstruktor - // festgelegt werden - readonly bool _hasCardsInSpokes = false; // readonly und private - - // Konstruktoren bestimmen was bei einer Instantiierung passiert. - // Das ist ein Default-Konstruktor: - public Bicycle() - { - // Member der Klasse können über das Keyword this erreicht werden - this.Gear = 1; - // oft ist das aber gar nicht nötig - Cadence = 50; - _speed = 5; - Name = "Bonanzarad"; - Brand = BikeBrand.Kynast; - BicyclesCreated++; - } - - // Das ist ein spezifischer Konstruktor (d.h. er erwartet Argumente): - public Bicycle(int startCadence, int startSpeed, int startGear, - string name, bool hasCardsInSpokes, BikeBrand brand) - : base() // ruft zuerst den "base"-Konstruktor auf - { - Gear = startGear; - Cadence = startCadence; - _speed = startSpeed; - Name = name; - _hasCardsInSpokes = hasCardsInSpokes; - Brand = brand; - } - - // Konstruktoren können aneinandergehängt werden: - public Bicycle(int startCadence, int startSpeed, BikeBrand brand) : - this(startCadence, startSpeed, 0, "richtig große Räder", true, brand) - { - } - - // Syntax für Methoden: - // () - - // Klassen können Getter und Setter für Werte definieren, - // oder diese Werte direkt als Eigenschaft implementieren - // (in C# der bevorzugte Weg) - - // Parameter von Methoden können Default-Werte haben. - // "SpeedUp" kann man also auch ohne Parameter aufrufen: - public void SpeedUp(int increment = 1) - { - _speed += increment; - } - - public void SlowDown(int decrement = 1) - { - _speed -= decrement; - } - - // Eigenschaften mit get/set - // wenn es nur um den Zugriff auf Daten geht, ist eine Eigenschaft zu - // empfehlen. Diese können Getter und Setter haben, oder auch nur - // einen Getter bzw. einen Setter - private bool _hasTassles; // private Variable - public bool HasTassles // öffentliches Interface - { - get { return _hasTassles; } - set { _hasTassles = value; } - } - - // Das kann man auch kürzer schreiben: - // Dieser Syntax erzeugt automatisch einen hinterlegten Wert, - // (entsprechend `private bool _isBroken`) der gesetzt - // bzw. zurückgegeben wird: - public bool IsBroken { get; private set; } - public int FrameSize - { - get; - // für Getter und Setter kann der Zugriff auch einzeln - // beschränkt werden, FrameSize kann also nur von innerhalb - // der Klasse "Bicycle" gesetzt werden - private set; - } - - // Diese Methode gibt eine Reihe an Informationen über das Objekt aus: - public virtual string ToString() - { - return "Gang: " + Gear + - " Kadenz: " + Cadence + - " Geschwindigkeit: " + _speed + - " Name: " + Name + - " Hipster-Karten zwischen den Speichen: " + (_hasCardsInSpokes ? "Na klar!" : "Bloß nicht!") + - "\n------------------------------\n" - ; - } - - // Auch Methoden können als static gekennzeichnet werden, nützlich - // beispielsweise für Helper-Methoden - public static bool DidWeCreateEnoughBicyclesYet() - { - // In einer statischen Methode können wir natürlich auch nur - // statische Member der Klasse referenzieren - return BicyclesCreated > 9000; - } - // Wenn eine Klasse nur statische Member enthält, kann es eine gute Idee - // sein die Klasse selbst als static zu kennzeichnen - - } // Ende der Klasse "Bicycle" - - // "PennyFarthing" ist eine Unterklasse von "Bicycle" - class PennyFarthing : Bicycle - { - // (Hochräder - englisch Penny Farthing - sind diese antiken Fahrräder - // mit riesigem Vorderrad. Sie haben keine Gangschaltung.) - - // hier wird einfach der Elternkonstruktor aufgerufen - public PennyFarthing(int startCadence, int startSpeed) : - base(startCadence, startSpeed, 0, "Hochrad", true, BikeBrand.EddyMerckx) - { - } - - protected override int Gear - { - get - { - return 0; - } - set - { - throw new ArgumentException("Ein Hochrad hat keine Gangschaltung, doh!"); - } - } - - public override string ToString() - { - string result = "Hochrad "; - result += base.ToString(); // ruft die "base"-Version der Methode auf - return result; - } - } - - // Interfaces (auch Schnittstellen genant) definieren nur die Signaturen - // ihrer Member, enthalten aber auf keinen Fall ihre Implementierung: - interface IJumpable - { - // Alle Member eines Interfaces sind implizit public - void Jump(int meters); - } - - interface IBreakable - { - // Interfaces können Eigenschaften, Methoden und Events definieren - bool Broken { get; } - } - - // Eine Klasse kann nur von einer Klasse erben, kann aber eine beliebige - // Anzahl von Interfaces implementieren - class MountainBike : Bicycle, IJumpable, IBreakable - { - int damage = 0; - - public void Jump(int meters) - { - damage += meters; - } - - public bool Broken - { - get - { - return damage > 100; - } - } - } - - // Das hier stellt eine Datenbankverbindung für das LinqToSql-Beispiel her. - // EntityFramework Code First ist großartig - // (ähnlich zu Ruby's ActiveRecord, aber bidirektional) - // http://msdn.microsoft.com/de-de/data/jj193542.aspx - public class BikeRepository : DbSet - { - public BikeRepository() - : base() - { - } - - public DbSet Bikes { get; set; } - } -} // Ende des Namespaces -``` - -## In dieser Übersicht nicht enthalten sind die Themen: - - * Flags - * Attributes - * Statische Eigenschaften - * Exceptions, Abstraction - * ASP.NET (Web Forms/MVC/WebMatrix) - * Winforms - * Windows Presentation Foundation (WPF) - -## Zum Weiterlesen gibt es viele gute Anlaufpunkte: - - * [DotNetPerls](http://www.dotnetperls.com) - * [C# in Depth](http://manning.com/skeet2) - * [Programming C#](http://shop.oreilly.com/product/0636920024064.do) - * [LINQ](http://shop.oreilly.com/product/9780596519254.do) - * [MSDN Library](http://msdn.microsoft.com/en-us/library/618ayhy6.aspx) - * [ASP.NET MVC Tutorials](http://www.asp.net/mvc/tutorials) - * [ASP.NET Web Matrix Tutorials](http://www.asp.net/web-pages/overview/exploring-webmatrix) - * [ASP.NET Web Forms Tutorials](http://www.asp.net/web-forms/tutorials) - * [Windows Forms Programming in C#](http://www.amazon.com/Windows-Forms-Programming-Chris-Sells/dp/0321116208) - -[C# Coding Conventions](http://msdn.microsoft.com/de-de/library/vstudio/ff926074.aspx) +--- +language: C# +contributors: + - ["Irfan Charania", "https://github.com/irfancharania"] + - ["Max Yankov", "https://github.com/golergka"] + - ["Melvyn Laïly", "http://x2a.yt"] + - ["Shaun McCarthy", "http://www.shaunmccarthy.com"] +translators: + - ["Frederik Ring", "https://github.com/m90"] +filename: LearnCSharp-de.cs +lang: de-de +--- +C# ist eine elegante, typsichere und objektorientierte Sprache, mit der Entwickler eine Vielzahl sicherer und robuster Anwendungen erstellen können, die im .NET Framework ausgeführt werden. + +[Mehr über C# erfährst du hier.](http://msdn.microsoft.com/de-de/library/vstudio/z1zx9t92.aspx) + +```c# +// Einzeilige Kommentare starten mit zwei Schrägstrichen: // +/* +Mehrzeile Kommentare wie in C Schrägstrich / Stern +*/ +/// +/// XML-Kommentare können zur automatisierten Dokumentation verwendet werden +/// + +// Zu Beginn werden die in der Datei verwendeten Namespaces aufgeführt +using System; +using System.Collections.Generic; +using System.Data.Entity; +using System.Dynamic; +using System.Linq; +using System.Linq.Expressions; +using System.Net; +using System.Threading.Tasks; +using System.IO; + +// definiert einen Namespace um Code in "packages" zu organisieren +namespace Learning +{ + // Jede .cs-Datei sollte zumindest eine Klasse mit dem Namen der Datei + // enthalten. Das ist zwar nicht zwingend erforderlich, es anders zu + // handhaben führt aber unweigerlich ins Chaos (wirklich)! + public class LearnCSharp + { + // Zuerst erklärt dieses Tutorial die Syntax-Grundlagen, + // wenn du bereits Java oder C++ programmieren kannst: + // lies bei "Interessante Features" weiter! + public static void Syntax() + { + // Mit Console.WriteLine kannst du einfachen Text ausgeben: + Console.WriteLine("Hallo Welt"); + Console.WriteLine( + "Integer: " + 10 + + " Double: " + 3.14 + + " Boolean: " + true); + + // Console.Write erzeugt keinen Zeilenumbruch + Console.Write("Hallo "); + Console.Write("Welt"); + + /////////////////////////////////////////////////// + // Typen & Variablen + /////////////////////////////////////////////////// + + // Deklariere eine Variable mit + + // Sbyte - Vorzeichenbehaftete 8-Bit Ganzzahl + // (-128 <= sbyte <= 127) + sbyte fooSbyte = 100; + + // Byte - Vorzeichenlose 8-Bit Ganzzahl + // (0 <= byte <= 255) + byte fooByte = 100; + + // Short - 16-Bit Ganzzahl + // Vorzeichenbehaftet - (-32,768 <= short <= 32,767) + // Vorzeichenlos - (0 <= ushort <= 65,535) + short fooShort = 10000; + ushort fooUshort = 10000; + + // Integer - 32-bit Ganzzahl + int fooInt = 1; // (-2,147,483,648 <= int <= 2,147,483,647) + uint fooUint = 1; // (0 <= uint <= 4,294,967,295) + + // Long - 64-bit Ganzzahl + long fooLong = 100000L; // (-9,223,372,036,854,775,808 <= long <= 9,223,372,036,854,775,807) + ulong fooUlong = 100000L; // (0 <= ulong <= 18,446,744,073,709,551,615) + // Ganze Zahlen werden standardmäßig - je nach Größe - als int oder + // uint behandelt. Ein nachgestelltes L markiert den Wert als long + // oder ulong. + + // Double - Double-precision 64-bit IEEE 754 Fließkommazahl + double fooDouble = 123.4; // Genauigkeit: 15-16 Stellen + + // Float - Single-precision 32-bit IEEE 754 Fließkommazahl + float fooFloat = 234.5f; // Genauigkeit: 7 Stellen + // Das nachgestellte f zeigt an dass es sich um einen Wert vom Typ + // float handelt + + // Decimal - ein 128-Bit-Datentyp mit größerer Genauigkeit als + // andere Fließkommatypen, und somit bestens geeignet für + // die Berechnung von Geld- und Finanzwerten + decimal fooDecimal = 150.3m; + + // Boolean - true & false + bool fooBoolean = true; // oder false + + // Char - Ein einzelnes 16-Bit Unicode Zeichen + char fooChar = 'A'; + + // Strings - im Gegensatz zu allen vorhergehenden Basistypen, die + // alle Werttypen sind, ist String ein Referenztyp. Strings sind + // somit nullable, Werttypen sind dies nicht. + string fooString = "\"maskiere\" Anführungszeichen, und füge \n (Umbrüche) und \t (Tabs) hinzu"; + Console.WriteLine(fooString); + + // Jeder Buchstabe eines Strings kann über seinen Index + // referenziert werden: + char charFromString = fooString[1]; // => 'e' + // Strings sind unveränderlich: + // `fooString[1] = 'X';` funktioniert nicht + + // Ein Vergleich zweier Strings, unter Berücksichtigung der + // aktuellen, sprachspezifischen Gegebenheiten (also z.B. a,ä,b,c + // in deutschsprachigen Umgebungen), und ohne Beachtung von + // Groß- und Kleinschreibung: + string.Compare(fooString, "x", StringComparison.CurrentCultureIgnoreCase); + + // Formatierung, genau wie "sprintf" + string fooFs = string.Format("Mikrofon Check, {0} {1}, {0} {1:0.0}", 1, 2); + + // Datumsangaben und Formatierung + DateTime fooDate = DateTime.Now; + Console.WriteLine(fooDate.ToString("hh:mm, dd MMM yyyy")); + + // Durch ein vorangestelltes @ lässt sich ein mehrzeiliger String + // schreiben. Um " zu maskieren benutzt man "" + string bazString = @"Hier geht es +zur nächsten Zeile, ""Wahnsinn!"", die Massen waren kaum zu bändigen"; + + // Die Keywords const oder readonly kennzeichnen eine + // unveränderliche Variable/Konstante. Die Werte von Konstanten + // werden übrigens bereits zur Compile-Zeit berechnet. + const int HOURS_I_WORK_PER_WEEK = 9001; + + /////////////////////////////////////////////////// + // Datenstrukturen + /////////////////////////////////////////////////// + + // Arrays - Index beginnt bei Null + // Die Größe des Arrays wird bei der Deklaration festgelegt. + // Die syntaktische Struktur um ein neues Array zu erzeugen sieht + // folgendermaßen aus: + // [] = new []; + int[] intArray = new int[10]; + + // Arrays können auch über ein Array-Literal deklariert werden: + int[] y = { 9000, 1000, 1337 }; + + // Indizierung eines Arrays - Zugriff auf ein bestimmtes Element + Console.WriteLine("intArray @ 0: " + intArray[0]); + // Arrays sind veränderbar + intArray[1] = 1; + + // Listen + // Durch ihre größere Flexibilität kommen Listen in C# weit + // häufiger zum Einsatz als Arrays. Eine Liste wird so deklariert: + // List = new List(); + List intList = new List(); + List stringList = new List(); + List z = new List { 9000, 1000, 1337 }; + // Die <> kennzeichnen "Generics", mehr dazu unter "Coole Sachen" + + // Listen haben keinen Default-Wert. + // Bevor auf einen Index zugegriffen werden kann, muss dieser + // auch gesetzt worden sein: + intList.Add(1); + Console.WriteLine("intList @ 0: " + intList[0]); + + // Andere interessante Datenstrukturen sind: + // Stack/Queue + // Dictionary (entspricht einer Hash Map) + // HashSet + // Read-only Collections + // Tuple (.Net 4+) + + /////////////////////////////////////// + // Operatoren + /////////////////////////////////////// + Console.WriteLine("\n->Operatoren"); + + // kurze Schreibweise um mehrere Deklarationen zusammenzufassen: + // (Benutzung vom C# Styleguide aber ausdrücklich abgeraten!) + int i1 = 1, i2 = 2; + + // Arithmetik funktioniert wie erwartet: + Console.WriteLine(i1 + i2 - i1 * 3 / 7); // => 3 + + // Modulo + Console.WriteLine("11%3 = " + (11 % 3)); // => 2 + + // Vergleiche + Console.WriteLine("3 == 2? " + (3 == 2)); // => false + Console.WriteLine("3 != 2? " + (3 != 2)); // => true + Console.WriteLine("3 > 2? " + (3 > 2)); // => true + Console.WriteLine("3 < 2? " + (3 < 2)); // => false + Console.WriteLine("2 <= 2? " + (2 <= 2)); // => true + Console.WriteLine("2 >= 2? " + (2 >= 2)); // => true + + // Bitweise Operatoren + /* + ~ Unäres bitweises NICHT + << Verschieben nach links + >> Verschieben nach rechts + & Bitweises UND + ^ Bitweises exklusives ODER + | Bitweises inklusives ODER + */ + + // Inkremente + int i = 0; + Console.WriteLine("\n->Inkrement / Dekrement"); + Console.WriteLine(i++); //i = 1. Post-Inkrement + Console.WriteLine(++i); //i = 2. Pre-Inkrement + Console.WriteLine(i--); //i = 1. Post-Dekrement + Console.WriteLine(--i); //i = 0. Pre-Dekrement + + /////////////////////////////////////// + // Kontrollstrukturen + /////////////////////////////////////// + Console.WriteLine("\n->Kontrollstrukturen"); + + // If-Statements funktionieren wie in C + int j = 10; + if (j == 10) + { + Console.WriteLine("Ich werde ausgegeben"); + } + else if (j > 10) + { + Console.WriteLine("Ich nicht"); + } + else + { + Console.WriteLine("Ich leider auch nicht"); + } + + // Ternärer Operator + // Anstatt eines einfachen if/else lässt sich auch folgendes schreiben: + // ? : + int zumVergleich = 17; + string isTrue = zumVergleich == 17 ? "Ja" : "Nein"; + + // while-Schleife + int fooWhile = 0; + while (fooWhile < 100) + { + // Wird 100mal wiederholt, fooWhile 0->99 + fooWhile++; + } + + // do-while-Schleife + int fooDoWhile = 0; + do + { + // Wird 100mal wiederholt, fooDoWhile 0->99 + fooDoWhile++; + } while (fooDoWhile < 100); + + //for-Schleifen => for(; ; ) + for (int fooFor = 0; fooFor < 10; fooFor++) + { + // Wird 10mal wiederholt, fooFor 0->9 + } + + // foreach-Schleife + // Die normale Syntax für eine foreach-Schleife lautet: + // foreach( in ) + // foreach kann mit jedem Objekt verwendet werden das IEnumerable + // oder IEnumerable implementiert. Alle Auflistungs-Typen + // (Array, List, Dictionary...) im .NET Framework implementieren + // eines dieser beiden Interfaces. + + foreach (char character in "Hallo Welt".ToCharArray()) + { + // Ein Durchgang für jedes Zeichen im String + } + // (ToCharArray() könnte man hier übrigens auch weglassen, + // da String IEnumerable bereits implementiert) + + // Switch Struktur + // Ein Switch funktioniert mit byte, short, char und int Datentypen. + // Auch Aufzählungstypen können verwendet werden, genau wie + // die Klasse String, und ein paar Sonderklassen, die Wrapper für + // Primitives sind: Character, Byte, Short und Integer + int month = 3; + string monthString; + switch (month) + { + case 1: + monthString = "Januar"; + break; + case 2: + monthString = "Februar"; + break; + case 3: + monthString = "März"; + break; + // Man kann für mehrere Fälle auch das selbe Verhalten + // definieren. Jeder Block muss aber mit einem break-Statement + // abgeschlossen werden. Einzelne Fälle können über + // `goto case x` erreicht werden + case 6: + case 7: + case 8: + monthString = "Sommer!!"; + break; + default: + monthString = "Irgendein anderer Monat"; + break; + } + + /////////////////////////////////////// + // Umwandlung von Datentypen und Typecasting + /////////////////////////////////////// + + // Umwandlung + + // von String nach Integer + // bei einem Fehler wirft diese Code eine Exception + int.Parse("123"); //gibt die Ganzzahl 123 zurück + + // TryParse gibt bei einem Fehler den Default-Wert zurück + // (im Fall von int: 0) + int tryInt; + if (int.TryParse("123", out tryInt)) // gibt true oder false zurück + { + Console.WriteLine(tryInt); // 123 + } + + // von Integer nach String + // Die Klasse Convert stellt Methoden zur Konvertierung von + // unterschiedlichsten Daten zur Verfügung: + Convert.ToString(123); // "123" + // oder + tryInt.ToString(); // "123" + } + + /////////////////////////////////////// + // Klassen + /////////////////////////////////////// + public static void Classes() + { + + // Benutze das new-Keyword um eine Instanz einer Klasse zu erzeugen + Bicycle trek = new Bicycle(); + + // So werden Methoden der Instanz aufgerufen + trek.SpeedUp(3); // Es empfiehlt sich immer Getter und Setter zu benutzen + trek.Cadence = 100; + + // ToString ist eine Konvention über die man üblicherweiser + // Informationen über eine Instanz erhält + Console.WriteLine("Infos zu trek: " + trek.ToString()); + + // Wir instantiieren ein neues Hochrad + PennyFarthing funbike = new PennyFarthing(1, 10); + Console.WriteLine("Infos zu funbike: " + funbike.ToString()); + + Console.Read(); + } // Ende der Methode main + + // Main als Konsolenstartpunkt + // Eine Konsolenanwendung muss eine Methode Main als Startpunkt besitzen + public static void Main(string[] args) + { + OtherInterestingFeatures(); + } + + /////////////////////////////////////// + // Interessante Features + /////////////////////////////////////// + + // Methodensignaturen + + public // Sichtbarkeit + static // Erlaubt einen Zugriff auf der Klasse (nicht auf einer Instanz) + int // Typ des Rückgabewerts, + MethodSignatures( + // Erstes Argument, erwartet int + int maxCount, + // setzt sich selbst auf 0 wenn kein anderer Wert übergeben wird + int count = 0, + int another = 3, + // enthält alle weiteren der Methode übergebenen Parameter (quasi Splats) + params string[] otherParams + ) + { + return -1; + } + + // Methoden können überladen werden, solange sie eindeutige + // Signaturen haben + public static void MethodSignatures(string maxCount) + { + } + + // Generische Typen + // Die Typen für TKey und TValue werden erst beim Aufruf der Methode + // festgelegt. Diese Methode emuliert z.B. SetDefault aus Python: + public static TValue SetDefault( + IDictionary dictionary, + TKey key, + TValue defaultItem) + { + TValue result; + if (!dictionary.TryGetValue(key, out result)) + { + return dictionary[key] = defaultItem; + } + return result; + } + + // Möglichen Typen lassen sich auch über ihr Interface beschränken: + public static void IterateAndPrint(T toPrint) where T: IEnumerable + { + // Da T ein IEnumerable ist können wir foreach benutzen + foreach (var item in toPrint) + { + // Item ist ein int + Console.WriteLine(item.ToString()); + } + } + + public static void OtherInterestingFeatures() + { + // Optionale Parameter + MethodSignatures(3, 1, 3, "Ein paar", "extra", "Strings"); + // setzt explizit einen bestimmten Parameter, andere werden übersprungen + MethodSignatures(3, another: 3); + + // Erweiterungsmethoden + int i = 3; + i.Print(); // Weiter unten definiert + + // Nullables - perfekt für die Interaktion mit + // Datenbanken / Rückgabewerten + // Jeder Wert (d.h. keine Klassen) kann durch das Nachstellen eines ? + // nullable gemacht werden: ? = + int? nullable = null; // Die explizite Langform wäre Nullable + Console.WriteLine("Mein Nullable: " + nullable); + bool hasValue = nullable.HasValue; // true wenn nicht null + + // ?? ist "syntaktischer Zucker" um einen Defaultwert für den Fall + // dass die Variable null ist festzulegen. + int notNullable = nullable ?? 0; // 0 + + // Implizit typisierte Variablen + // Man kann auch den Typ einer Variable auch vom Compiler + // bestimmen lassen: + var magic = "magic ist zur Compile-Zeit ein String, folglich geht keine Typsicherheit verloren"; + magic = 9; // funktioniert nicht da magic vom Typ String ist + + // Generics + var phonebook = new Dictionary() { + {"Resi", "08822 / 43 67"} // Fügt einen Eintrag zum Telefonbuch hinzu + }; + + // Hier könnte man auch unser generisches SetDefault von + // weiter oben benutzen: + Console.WriteLine(SetDefault(phonebook, "Xaver", "kein Telefon")); // kein Telefon + // TKey und TValue müssen nicht zwingend angegeben werden, da sie + // auch implizit vom Compiler ermittelt werden können + Console.WriteLine(SetDefault(phonebook, "Resi", "kein Telefon")); // 08822 / 43 67 + + // Lambdas - konzise Syntax für Inline-Funktionen + Func square = (x) => x * x; // Das letzte Element vom Typ T ist der Rückgabewert + Console.WriteLine(square(3)); // 9 + + // Disposables - einfaches Management von nicht verwalteten Ressourcen + // So gut wie alle Objekte die auf nicht verwaltete Ressourcen + // (Dateien, Geräte, ...) zugreifen, implementieren das Interface + // IDisposable. Das using Statement stellt sicher dass die vom + // IDisposable benutzten Ressourcen nach der Benutzung wieder + // freigegeben werden: + using (StreamWriter writer = new StreamWriter("log.txt")) + { + writer.WriteLine("Alles bestens!"); + // Am Ende des Codeblocks werden die Ressourcen wieder + // freigegeben - auch im Falle einer Exception + } + + // Parallel Klasse + // http://blogs.msdn.com/b/csharpfaq/archive/2010/06/01/parallel-programming-in-net-framework-4-getting-started.aspx + var websites = new string[] { + "http://www.google.com", "http://www.reddit.com", + "http://www.shaunmccarthy.com" + }; + var responses = new Dictionary(); + + // Für jeden Request wird ein neuer Thread erzeugt, der nächste + // Schritt wird erst nach Beendigung aller Tasks ausgeführt + Parallel.ForEach(websites, + // maximal 3 Threads gleichzeitig + new ParallelOptions() {MaxDegreeOfParallelism = 3}, + website => + { + // Hier folgt eine langwierige, asynchrone Operation + using (var r = WebRequest.Create(new Uri(website)).GetResponse()) + { + responses[website] = r.ContentType; + } + }); + + // Dieser Code wird erst nach Beendigung aller Requests ausgeführt + foreach (var key in responses.Keys) + { + Console.WriteLine("{0}:{1}", key, responses[key]); + } + + // Dynamische Objekte (gut um mit anderen Sprachen zu arbeiten) + dynamic student = new ExpandoObject(); + // hier muss keine Typ angegeben werden + student.FirstName = "Christian"; + + // Einem solchen Objekt kann man sogar Methoden zuordnen. + // Das Beispiel gibt einen String zurück und erwartet einen String + student.Introduce = new Func( + (introduceTo) => string.Format("Hallo {0}, das ist {1}", student.FirstName, introduceTo)); + Console.WriteLine(student.Introduce("Bettina")); + + // IQueryable - So gut wie alle Aufzählungstypen implementieren + // dieses Interface, welches eine Vielzahl von funktionalen Methoden + // wie Map / Filter / Reduce zur Verfügung stellt: + var bikes = new List(); + // sortiert die Liste + bikes.Sort(); + // sortiert nach Anzahl Räder + bikes.Sort((b1, b2) => b1.Wheels.CompareTo(b2.Wheels)); + var result = bikes + // diese Filter können auch aneinandergehängt werden + .Where(b => b.Wheels > 3) // (gibt ein IQueryable des vorherigen Typs zurück) + .Where(b => b.IsBroken && b.HasTassles) + // diese Zuordnung gibt ein IQueryable zurück + .Select(b => b.ToString()); + + // "Reduce" - addiert alle Räder der Aufzählung zu einem Wert + var sum = bikes.Sum(b => b.Wheels); + + // So erzeugt man ein implizit typisiertes Objekt, basierend auf + // den Parametern der Elemente: + var bikeSummaries = bikes.Select(b=>new { Name = b.Name, IsAwesome = !b.IsBroken && b.HasTassles }); + // Auch wenn wir es hier nicht demonstrieren können: + // In einer IDE wie VisualStudio kriegen wir hier sogar TypeAhead, + // da der Compiler in der Lage ist, die passenden Typen zu erkennen. + foreach (var bikeSummary in bikeSummaries.Where(b => b.IsAwesome)) + { + Console.WriteLine(bikeSummary.Name); + } + + // AsParallel-Methode + // Jetzt kommen die Schmankerl! Die AsParallel-Methode kombiniert + // LINQ und parallele Operationen: + var threeWheelers = bikes.AsParallel().Where(b => b.Wheels == 3).Select(b => b.Name); + // Diese Berechnung passiert parallel! Benötigte Threads werden + // automatisch erzeugt, und die Rechenlast unter ihnen aufgeteilt. + // Ein Traum für die Verarbeitung von großen Datenmengen + // auf mehreren Cores! + + // LINQ - bildet einen Datenspeicher auf IQueryable Objekte ab + // LinqToSql beispielsweise speichert und liest aus einer + // SQL-Datenbank, LinqToXml aus einem XML-Dokument. + // LINQ-Operationen werden "lazy" ausgeführt. + var db = new BikeRepository(); + + // Die verzögerte Ausführung ist optimal für Datenbankabfragen + var filter = db.Bikes.Where(b => b.HasTassles); // noch keine Abfrage + // Es können noch mehr Filter hinzugefügt werden (auch mit + // Bedingungen) - ideal für z.B. "erweiterte Suchen" + if (42 > 6) + { + filter = filter.Where(b => b.IsBroken); // immer noch keine Abfrage + } + + var query = filter + .OrderBy(b => b.Wheels) + .ThenBy(b => b.Name) + .Select(b => b.Name); // auch hier: immer noch keine Abfrage + + // Erst hier wird die Datenbankabfrage wirklich ausgeführt, + // limitiert auf die Elemente die der foreach-Loop verwendet + foreach (string bike in query) + { + Console.WriteLine(result); + } + + } + + } // Ende der Klasse LearnCSharp + + // Eine .cs-Datei kann auch mehrere Klassen enthalten + + public static class Extensions + { + // Erweiterungsmethoden + public static void Print(this object obj) + { + Console.WriteLine(obj.ToString()); + } + } + + // Syntax zur Deklaration einer Klasse: + // class { + // // Datenfelder, Konstruktoren und Methoden leben alle + // // innerhalb dieser Deklaration + // } + + public class Bicycle + { + // Felder/Variablen der Klasse "Bicycle" + // Das Keyword public macht das Member von überall zugänglich + public int Cadence + { + get // get definiert eine Methode um die Eigenschaft abzurufen + { + return _cadence; + } + set // set definiert eine Methode um die Eigenschaft zu setzen + { + _cadence = value; // value ist der dem Setter übergebene Wert + } + } + private int _cadence; + + // Das Keyword protected macht das Member nur für die Klasse selbst + // und ihre Subklassen zugänglich + protected virtual int Gear + { + get; // erzeugt eine Eigenschaft für die kein "Zwischenwert" benötigt wird + set; + } + + // Das Keyword internal macht das Member innerhalb der Assembly zugänglich + internal int Wheels + { + get; + private set; // get/set kann auch über Keywords modifiziert werden + } + + int _speed; // Member ohne vorangestellte Keywords sind standardmäßig + // private, sie sind nur innerhalb der Klasse zugänglich. + // Man kann aber natürlich auch das Keyword private benutzen. + private string Name { get; set; } + + // Ein Enum ist ein klar definierter Satz an benannten Konstanten. + // Eigentlich ordnet es diese Konstanten nur bestimmten Werten zu + // (einer int-Zahl, solange nicht anders angegeben). Mögliche Typen für + // die Werte eines Enums sind byte, sbyte, short, ushort, int, uint, + // long, oder ulong. Alle Werte in einem Enum sind eindeutig. + public enum BikeBrand + { + Colnago, + EddyMerckx, + Bianchi = 42, // so kann man den Wert explizit setzen + Kynast // 43 + } + // Nachdem dieser Typ in der Klasse "Bicycle" definiert ist, + // sollte Code ausserhalb der Klasse den Typen als Bicycle.Brand referenzieren + + // Nachdem das Enum deklariert ist, können wir den Typen verwenden: + public BikeBrand Brand; + + // Als static gekennzeichnete Member gehören dem Typ selbst, + // nicht seinen Instanzen. Man kann sie also ohne Referenz zu einem + // Objekt benutzen + // Console.WriteLine("Schon " + Bicycle.BicyclesCreated + " Fahrräder, nur für dieses Tutorial!"); + static public int BicyclesCreated = 0; + + // readonly-Werte werden zur Laufzeit gesetzt + // Ihr Wert kann nur bei ihrer Deklaration, oder in einem Konstruktor + // festgelegt werden + readonly bool _hasCardsInSpokes = false; // readonly und private + + // Konstruktoren bestimmen was bei einer Instantiierung passiert. + // Das ist ein Default-Konstruktor: + public Bicycle() + { + // Member der Klasse können über das Keyword this erreicht werden + this.Gear = 1; + // oft ist das aber gar nicht nötig + Cadence = 50; + _speed = 5; + Name = "Bonanzarad"; + Brand = BikeBrand.Kynast; + BicyclesCreated++; + } + + // Das ist ein spezifischer Konstruktor (d.h. er erwartet Argumente): + public Bicycle(int startCadence, int startSpeed, int startGear, + string name, bool hasCardsInSpokes, BikeBrand brand) + : base() // ruft zuerst den "base"-Konstruktor auf + { + Gear = startGear; + Cadence = startCadence; + _speed = startSpeed; + Name = name; + _hasCardsInSpokes = hasCardsInSpokes; + Brand = brand; + } + + // Konstruktoren können aneinandergehängt werden: + public Bicycle(int startCadence, int startSpeed, BikeBrand brand) : + this(startCadence, startSpeed, 0, "richtig große Räder", true, brand) + { + } + + // Syntax für Methoden: + // () + + // Klassen können Getter und Setter für Werte definieren, + // oder diese Werte direkt als Eigenschaft implementieren + // (in C# der bevorzugte Weg) + + // Parameter von Methoden können Default-Werte haben. + // "SpeedUp" kann man also auch ohne Parameter aufrufen: + public void SpeedUp(int increment = 1) + { + _speed += increment; + } + + public void SlowDown(int decrement = 1) + { + _speed -= decrement; + } + + // Eigenschaften mit get/set + // wenn es nur um den Zugriff auf Daten geht, ist eine Eigenschaft zu + // empfehlen. Diese können Getter und Setter haben, oder auch nur + // einen Getter bzw. einen Setter + private bool _hasTassles; // private Variable + public bool HasTassles // öffentliches Interface + { + get { return _hasTassles; } + set { _hasTassles = value; } + } + + // Das kann man auch kürzer schreiben: + // Dieser Syntax erzeugt automatisch einen hinterlegten Wert, + // (entsprechend `private bool _isBroken`) der gesetzt + // bzw. zurückgegeben wird: + public bool IsBroken { get; private set; } + public int FrameSize + { + get; + // für Getter und Setter kann der Zugriff auch einzeln + // beschränkt werden, FrameSize kann also nur von innerhalb + // der Klasse "Bicycle" gesetzt werden + private set; + } + + // Diese Methode gibt eine Reihe an Informationen über das Objekt aus: + public virtual string ToString() + { + return "Gang: " + Gear + + " Kadenz: " + Cadence + + " Geschwindigkeit: " + _speed + + " Name: " + Name + + " Hipster-Karten zwischen den Speichen: " + (_hasCardsInSpokes ? "Na klar!" : "Bloß nicht!") + + "\n------------------------------\n" + ; + } + + // Auch Methoden können als static gekennzeichnet werden, nützlich + // beispielsweise für Helper-Methoden + public static bool DidWeCreateEnoughBicyclesYet() + { + // In einer statischen Methode können wir natürlich auch nur + // statische Member der Klasse referenzieren + return BicyclesCreated > 9000; + } + // Wenn eine Klasse nur statische Member enthält, kann es eine gute Idee + // sein die Klasse selbst als static zu kennzeichnen + + } // Ende der Klasse "Bicycle" + + // "PennyFarthing" ist eine Unterklasse von "Bicycle" + class PennyFarthing : Bicycle + { + // (Hochräder - englisch Penny Farthing - sind diese antiken Fahrräder + // mit riesigem Vorderrad. Sie haben keine Gangschaltung.) + + // hier wird einfach der Elternkonstruktor aufgerufen + public PennyFarthing(int startCadence, int startSpeed) : + base(startCadence, startSpeed, 0, "Hochrad", true, BikeBrand.EddyMerckx) + { + } + + protected override int Gear + { + get + { + return 0; + } + set + { + throw new ArgumentException("Ein Hochrad hat keine Gangschaltung, doh!"); + } + } + + public override string ToString() + { + string result = "Hochrad "; + result += base.ToString(); // ruft die "base"-Version der Methode auf + return result; + } + } + + // Interfaces (auch Schnittstellen genant) definieren nur die Signaturen + // ihrer Member, enthalten aber auf keinen Fall ihre Implementierung: + interface IJumpable + { + // Alle Member eines Interfaces sind implizit public + void Jump(int meters); + } + + interface IBreakable + { + // Interfaces können Eigenschaften, Methoden und Events definieren + bool Broken { get; } + } + + // Eine Klasse kann nur von einer Klasse erben, kann aber eine beliebige + // Anzahl von Interfaces implementieren + class MountainBike : Bicycle, IJumpable, IBreakable + { + int damage = 0; + + public void Jump(int meters) + { + damage += meters; + } + + public bool Broken + { + get + { + return damage > 100; + } + } + } + + // Das hier stellt eine Datenbankverbindung für das LinqToSql-Beispiel her. + // EntityFramework Code First ist großartig + // (ähnlich zu Ruby's ActiveRecord, aber bidirektional) + // http://msdn.microsoft.com/de-de/data/jj193542.aspx + public class BikeRepository : DbSet + { + public BikeRepository() + : base() + { + } + + public DbSet Bikes { get; set; } + } +} // Ende des Namespaces +``` + +## In dieser Übersicht nicht enthalten sind die Themen: + + * Flags + * Attributes + * Statische Eigenschaften + * Exceptions, Abstraction + * ASP.NET (Web Forms/MVC/WebMatrix) + * Winforms + * Windows Presentation Foundation (WPF) + +## Zum Weiterlesen gibt es viele gute Anlaufpunkte: + + * [DotNetPerls](http://www.dotnetperls.com) + * [C# in Depth](http://manning.com/skeet2) + * [Programming C#](http://shop.oreilly.com/product/0636920024064.do) + * [LINQ](http://shop.oreilly.com/product/9780596519254.do) + * [MSDN Library](http://msdn.microsoft.com/en-us/library/618ayhy6.aspx) + * [ASP.NET MVC Tutorials](http://www.asp.net/mvc/tutorials) + * [ASP.NET Web Matrix Tutorials](http://www.asp.net/web-pages/overview/exploring-webmatrix) + * [ASP.NET Web Forms Tutorials](http://www.asp.net/web-forms/tutorials) + * [Windows Forms Programming in C#](http://www.amazon.com/Windows-Forms-Programming-Chris-Sells/dp/0321116208) + +[C# Coding Conventions](http://msdn.microsoft.com/de-de/library/vstudio/ff926074.aspx) diff --git a/de-de/elixir-de.html.markdown b/de-de/elixir-de.html.markdown index ec933696..4acb8e23 100644 --- a/de-de/elixir-de.html.markdown +++ b/de-de/elixir-de.html.markdown @@ -1,423 +1,423 @@ ---- -language: Elixir -contributors: - - ["Joao Marques", "http://github.com/mrshankly"] -translators: - - ["Gregor Große-Bölting", "http://www.ideen-und-soehne.de"] -filename: learnelixir-de.ex -lang: de-de ---- - -Elixir ist eine moderne, funktionale Sprache für die Erlang VM. Sie ist voll -kompatibel mit Erlang, verfügt aber über eine freundlichere Syntax und bringt -viele Features mit. - -```ruby - -# Einzeilige Kommentare werden mit der Raute gesetzt. - -# Es gibt keine mehrzeiligen Kommentare; -# es ist aber problemlos möglich mehrere einzeilige Kommentare hintereinander -# zu setzen (so wie hier). - -# Mit 'iex' ruft man die Elixir-Shell auf. -# Zum kompilieren von Modulen dient der Befehl 'elixirc'. - -# Beide Befehle sollten als Umgebungsvariable gesetzt sein, wenn Elixir korrekt -# installiert wurde. - -## --------------------------- -## -- Basistypen -## --------------------------- - -# Es gibt Nummern: -3 # Integer -0x1F # Integer -3.0 # Float - -# Für bessere Lesbarkeit des Codes können Unterstriche "_" als Trennzeichen verwendet werden -1_000_000 == 1000000 # Integer -1_000.567 == 1000.567 # Float - -# Atome, das sind Literale, sind Konstanten mit Namen. Sie starten mit einem -# ':'. -:hello # Atom - -# Außerdem gibt es Tupel, deren Werte im Arbeitsspeicher vorgehalten werden. -{1,2,3} # Tupel - -# Die Werte innerhalb eines Tupels können mit der 'elem'-Funktion ausgelesen -# werden: -elem({1, 2, 3}, 0) # => 1 - -# Listen sind als verkettete Listen implementiert. -[1, 2, 3] # list - -# Auf Kopf und Rest einer Liste kann wie folgt zugegriffen werden: -[ kopf | rest ] = [1,2,3] -kopf # => 1 -rest # => [2, 3] - -# In Elixir, wie auch in Erlang, kennzeichnet '=' ein 'pattern matching' -# (Musterabgleich) und keine Zuweisung. -# Das heißt, dass die linke Seite auf die rechte Seite 'abgeglichen' wird. -# Auf diese Weise kann im Beispiel oben auf Kopf und Rest der Liste zugegriffen -# werden. - -# Ein Musterabgleich wird einen Fehler werfen, wenn die beiden Seiten nicht -# zusammenpassen. -# Im folgenden Beispiel haben die Tupel eine unterschiedliche Anzahl an -# Elementen: -{a, b, c} = {1, 2} #=> ** (MatchError) no match of right hand side value: {1,2} - -# Es gibt außerdem 'binaries', -<<1,2,3>> # binary. - -# Strings und 'char lists' -"hello" # String -'hello' # Char-Liste - -# ... und mehrzeilige Strings -""" -Ich bin ein -mehrzeiliger String. -""" -#=> "Ich bin ein\nmehrzeiliger String.\n" - -# Alles Strings werden in UTF-8 enkodiert: -"héllò" #=> "héllò" - -# Eigentlich sind Strings in Wahrheit nur binaries und 'char lists' einfach -# Listen. -<> #=> "abc" -[?a, ?b, ?c] #=> 'abc' - -# In Elixir gibt `?a` den ASCII-Integer für den Buchstaben zurück. -?a #=> 97 - -# Um Listen zu verbinden gibt es den Operator '++', für binaries nutzt man '<>' -[1,2,3] ++ [4,5] #=> [1,2,3,4,5] -'hello ' ++ 'world' #=> 'hello world' - -<<1,2,3>> <> <<4,5>> #=> <<1,2,3,4,5>> -"hello " <> "world" #=> "hello world" - -## --------------------------- -## -- Operatoren -## --------------------------- - -# Einfache Arithmetik -1 + 1 #=> 2 -10 - 5 #=> 5 -5 * 2 #=> 10 -10 / 2 #=> 5.0 - -# In Elixir gibt der Operator '/' immer einen Float-Wert zurück. - -# Für Division mit ganzzahligen Ergebnis gibt es 'div' -div(10, 2) #=> 5 - -# Um den Rest der ganzzahligen Division zu erhalten gibt es 'rem' -rem(10, 3) #=> 1 - -# Natürlich gibt es auch Operatoren für Booleans: 'or', 'and' und 'not'. Diese -# Operatoren erwarten einen Boolean als erstes Argument. -true and true #=> true -false or true #=> true -# 1 and true #=> ** (ArgumentError) argument error - -# Elixir bietet auch '||', '&&' und '!', die Argumente jedweden Typs -# akzeptieren. Alle Werte außer 'false' und 'nil' werden zu wahr evaluiert. -1 || true #=> 1 -false && 1 #=> false -nil && 20 #=> nil - -!true #=> false - -# Für Vergleiche gibt es die Operatoren `==`, `!=`, `===`, `!==`, `<=`, `>=`, -# `<` und `>` -1 == 1 #=> true -1 != 1 #=> false -1 < 2 #=> true - -# '===' und '!==' sind strikter beim Vergleich von Integern und Floats: -1 == 1.0 #=> true -1 === 1.0 #=> false - -# Es ist außerdem möglich zwei verschiedene Datentypen zu vergleichen: -1 < :hello #=> true - -# Die gesamte Ordnung über die Datentypen ist wie folgt definiert: -# number < atom < reference < functions < port < pid < tuple < list < bitstring - -# Um Joe Armstrong zu zitieren: "The actual order is not important, but that a -# total ordering is well defined is important." - -## --------------------------- -## -- Kontrollstrukturen -## --------------------------- - -# Es gibt die `if`-Verzweigung -if false do - "Dies wird nie jemand sehen..." -else - "...aber dies!" -end - -# ...und ebenso `unless` -unless true do - "Dies wird nie jemand sehen..." -else - "...aber dies!" -end - -# Du erinnerst dich an 'pattern matching'? Viele Kontrollstrukturen in Elixir -# arbeiten damit. - -# 'case' erlaubt es uns Werte mit vielerlei Mustern zu vergleichen. -case {:one, :two} do - {:four, :five} -> - "Das wird nicht passen" - {:one, x} -> - "Das schon und außerdem wird es ':two' dem Wert 'x' zuweisen." - _ -> - "Dieser Fall greift immer." -end - -# Es ist eine übliche Praxis '_' einen Wert zuzuweisen, sofern dieser Wert -# nicht weiter verwendet wird. -# Wenn wir uns zum Beispiel nur für den Kopf einer Liste interessieren: -[kopf | _] = [1,2,3] -kopf #=> 1 - -# Für bessere Lesbarkeit können wir auch das Folgende machen: -[kopf | _rest] = [:a, :b, :c] -kopf #=> :a - -# Mit 'cond' können diverse Bedingungen zur selben Zeit überprüft werden. Man -# benutzt 'cond' statt viele if-Verzweigungen zu verschachteln. -cond do - 1 + 1 == 3 -> - "Ich werde nie aufgerufen." - 2 * 5 == 12 -> - "Ich auch nicht." - 1 + 2 == 3 -> - "Aber ich!" -end - -# Es ist üblich eine letzte Bedingung einzufügen, die immer zu wahr evaluiert. -cond do - 1 + 1 == 3 -> - "Ich werde nie aufgerufen." - 2 * 5 == 12 -> - "Ich auch nicht." - true -> - "Aber ich! (dies ist im Grunde ein 'else')" -end - -# 'try/catch' wird verwendet um Werte zu fangen, die zuvor 'geworfen' wurden. -# Das Konstrukt unterstützt außerdem eine 'after'-Klausel die aufgerufen wird, -# egal ob zuvor ein Wert gefangen wurde. -try do - throw(:hello) -catch - nachricht -> "#{nachricht} gefangen." -after - IO.puts("Ich bin die 'after'-Klausel.") -end -#=> Ich bin die 'after'-Klausel. -# ":hello gefangen" - -## --------------------------- -## -- Module und Funktionen -## --------------------------- - -# Anonyme Funktionen (man beachte den Punkt) -square = fn(x) -> x * x end -square.(5) #=> 25 - -# Anonyme Funktionen unterstützen auch 'pattern' und 'guards'. Guards erlauben -# es die Mustererkennung zu justieren und werden mit dem Schlüsselwort 'when' -# eingeführt: -f = fn - x, y when x > 0 -> x + y - x, y -> x * y -end - -f.(1, 3) #=> 4 -f.(-1, 3) #=> -3 - -# Elixir bietet zahlreiche eingebaute Funktionen. Diese sind im gleichen -# Geltungsbereich ('scope') verfügbar. -is_number(10) #=> true -is_list("hello") #=> false -elem({1,2,3}, 0) #=> 1 - -# Mehrere Funktionen können in einem Modul gruppiert werden. Innerhalb eines -# Moduls ist es möglich mit dem Schlüsselwort 'def' eine Funktion zu -# definieren. -defmodule Math do - def sum(a, b) do - a + b - end - - def square(x) do - x * x - end -end - -Math.sum(1, 2) #=> 3 -Math.square(3) #=> 9 - -# Um unser einfaches Mathe-Modul zu kompilieren muss es unter 'math.ex' -# gesichert werden. Anschließend kann es mit 'elixirc' im Terminal aufgerufen -# werden: elixirc math.ex - -# Innerhalb eines Moduls definieren wir private Funktionen mit 'defp'. Eine -# Funktion, die mit 'def' erstellt wurde, kann von anderen Modulen aufgerufen -# werden; eine private Funktion kann nur lokal angesprochen werden. -defmodule PrivateMath do - def sum(a, b) do - do_sum(a, b) - end - - defp do_sum(a, b) do - a + b - end -end - -PrivateMath.sum(1, 2) #=> 3 -# PrivateMath.do_sum(1, 2) #=> ** (UndefinedFunctionError) - -# Auch Funktionsdeklarationen unterstützen 'guards' und Mustererkennung: -defmodule Geometry do - def area({:rectangle, w, h}) do - w * h - end - - def area({:circle, r}) when is_number(r) do - 3.14 * r * r - end -end - -Geometry.area({:rectangle, 2, 3}) #=> 6 -Geometry.area({:circle, 3}) #=> 28.25999999999999801048 -# Geometry.area({:circle, "not_a_number"}) -#=> ** (FunctionClauseError) no function clause matching in Geometry.area/1 - -# Wegen der Unveränderlichkeit von Variablen ist Rekursion ein wichtiger -# Bestandteil von Elixir. -defmodule Recursion do - def sum_list([head | tail], acc) do - sum_list(tail, acc + head) - end - - def sum_list([], acc) do - acc - end -end - -Recursion.sum_list([1,2,3], 0) #=> 6 - -# Elixir-Module unterstützen Attribute. Es gibt eingebaute Attribute, ebenso -# ist es möglich eigene Attribute hinzuzufügen. -defmodule MyMod do - @moduledoc """ - Dies ist ein eingebautes Attribut in einem Beispiel-Modul - """ - - @my_data 100 # Dies ist ein selbst-definiertes Attribut. - IO.inspect(@my_data) #=> 100 -end - -## --------------------------- -## -- 'Records' und Ausnahmebehandlung -## --------------------------- - -# 'Records' sind im Grunde Strukturen, die es erlauben einem Wert einen eigenen -# Namen zuzuweisen. -defrecord Person, name: nil, age: 0, height: 0 - -joe_info = Person.new(name: "Joe", age: 30, height: 180) -#=> Person[name: "Joe", age: 30, height: 180] - -# Zugriff auf den Wert von 'name' -joe_info.name #=> "Joe" - -# Den Wert von 'age' überschreiben -joe_info = joe_info.age(31) #=> Person[name: "Joe", age: 31, height: 180] - -# Der 'try'-Block wird zusammen mit dem 'rescue'-Schlüsselwort dazu verwendet, -# um Ausnahmen beziehungsweise Fehler zu behandeln. -try do - raise "Irgendein Fehler." -rescue - RuntimeError -> "Laufzeit-Fehler gefangen." - _error -> "Und dies fängt jeden Fehler." -end - -# Alle Ausnahmen haben das Attribut 'message' -try do - raise "ein Fehler" -rescue - x in [RuntimeError] -> - x.message -end - -## --------------------------- -## -- Nebenläufigkeit -## --------------------------- - -# Elixir beruht auf dem Aktoren-Model zur Behandlung der Nebenläufigkeit. Alles -# was man braucht um in Elixir nebenläufige Programme zu schreiben sind drei -# Primitive: Prozesse erzeugen, Nachrichten senden und Nachrichten empfangen. - -# Um einen neuen Prozess zu erzeugen nutzen wir die 'spawn'-Funktion, die -# wiederum eine Funktion als Argument entgegen nimmt. -f = fn -> 2 * 2 end #=> #Function -spawn(f) #=> #PID<0.40.0> - -# 'spawn' gibt eine pid (einen Identifikator des Prozesses) zurück. Diese kann -# nun verwendet werden, um Nachrichten an den Prozess zu senden. Um -# zu senden nutzen wir den '<-' Operator. Damit das alles Sinn macht müssen wir -# in der Lage sein Nachrichten zu empfangen. Dies wird mit dem -# 'receive'-Mechanismus sichergestellt: -defmodule Geometry do - def area_loop do - receive do - {:rectangle, w, h} -> - IO.puts("Area = #{w * h}") - area_loop() - {:circle, r} -> - IO.puts("Area = #{3.14 * r * r}") - area_loop() - end - end -end - -# Kompiliere das Modul, starte einen Prozess und gib die 'area_loop' Funktion -# in der Shell mit, etwa so: -pid = spawn(fn -> Geometry.area_loop() end) #=> #PID<0.40.0> - -# Sende eine Nachricht an die 'pid', die ein Muster im 'receive'-Ausdruck -# erfüllt: -pid <- {:rectangle, 2, 3} -#=> Area = 6 -# {:rectangle,2,3} - -pid <- {:circle, 2} -#=> Area = 12.56000000000000049738 -# {:circle,2} - -# Die Shell selbst ist ein Prozess und mit dem Schlüsselwort 'self' kann man -# die aktuelle pid herausfinden. -self() #=> #PID<0.27.0> - -``` - -## Referenzen und weitere Lektüre - -* [Getting started guide](http://elixir-lang.org/getting_started/1.html) auf der [elixir Website](http://elixir-lang.org) -* [Elixir Documentation](http://elixir-lang.org/docs/master/) -* ["Learn You Some Erlang for Great Good!"](http://learnyousomeerlang.com/) von Fred Hebert -* "Programming Erlang: Software for a Concurrent World" von Joe Armstrong +--- +language: Elixir +contributors: + - ["Joao Marques", "http://github.com/mrshankly"] +translators: + - ["Gregor Große-Bölting", "http://www.ideen-und-soehne.de"] +filename: learnelixir-de.ex +lang: de-de +--- + +Elixir ist eine moderne, funktionale Sprache für die Erlang VM. Sie ist voll +kompatibel mit Erlang, verfügt aber über eine freundlichere Syntax und bringt +viele Features mit. + +```ruby + +# Einzeilige Kommentare werden mit der Raute gesetzt. + +# Es gibt keine mehrzeiligen Kommentare; +# es ist aber problemlos möglich mehrere einzeilige Kommentare hintereinander +# zu setzen (so wie hier). + +# Mit 'iex' ruft man die Elixir-Shell auf. +# Zum kompilieren von Modulen dient der Befehl 'elixirc'. + +# Beide Befehle sollten als Umgebungsvariable gesetzt sein, wenn Elixir korrekt +# installiert wurde. + +## --------------------------- +## -- Basistypen +## --------------------------- + +# Es gibt Nummern: +3 # Integer +0x1F # Integer +3.0 # Float + +# Für bessere Lesbarkeit des Codes können Unterstriche "_" als Trennzeichen verwendet werden +1_000_000 == 1000000 # Integer +1_000.567 == 1000.567 # Float + +# Atome, das sind Literale, sind Konstanten mit Namen. Sie starten mit einem +# ':'. +:hello # Atom + +# Außerdem gibt es Tupel, deren Werte im Arbeitsspeicher vorgehalten werden. +{1,2,3} # Tupel + +# Die Werte innerhalb eines Tupels können mit der 'elem'-Funktion ausgelesen +# werden: +elem({1, 2, 3}, 0) # => 1 + +# Listen sind als verkettete Listen implementiert. +[1, 2, 3] # list + +# Auf Kopf und Rest einer Liste kann wie folgt zugegriffen werden: +[ kopf | rest ] = [1,2,3] +kopf # => 1 +rest # => [2, 3] + +# In Elixir, wie auch in Erlang, kennzeichnet '=' ein 'pattern matching' +# (Musterabgleich) und keine Zuweisung. +# Das heißt, dass die linke Seite auf die rechte Seite 'abgeglichen' wird. +# Auf diese Weise kann im Beispiel oben auf Kopf und Rest der Liste zugegriffen +# werden. + +# Ein Musterabgleich wird einen Fehler werfen, wenn die beiden Seiten nicht +# zusammenpassen. +# Im folgenden Beispiel haben die Tupel eine unterschiedliche Anzahl an +# Elementen: +{a, b, c} = {1, 2} #=> ** (MatchError) no match of right hand side value: {1,2} + +# Es gibt außerdem 'binaries', +<<1,2,3>> # binary. + +# Strings und 'char lists' +"hello" # String +'hello' # Char-Liste + +# ... und mehrzeilige Strings +""" +Ich bin ein +mehrzeiliger String. +""" +#=> "Ich bin ein\nmehrzeiliger String.\n" + +# Alles Strings werden in UTF-8 enkodiert: +"héllò" #=> "héllò" + +# Eigentlich sind Strings in Wahrheit nur binaries und 'char lists' einfach +# Listen. +<> #=> "abc" +[?a, ?b, ?c] #=> 'abc' + +# In Elixir gibt `?a` den ASCII-Integer für den Buchstaben zurück. +?a #=> 97 + +# Um Listen zu verbinden gibt es den Operator '++', für binaries nutzt man '<>' +[1,2,3] ++ [4,5] #=> [1,2,3,4,5] +'hello ' ++ 'world' #=> 'hello world' + +<<1,2,3>> <> <<4,5>> #=> <<1,2,3,4,5>> +"hello " <> "world" #=> "hello world" + +## --------------------------- +## -- Operatoren +## --------------------------- + +# Einfache Arithmetik +1 + 1 #=> 2 +10 - 5 #=> 5 +5 * 2 #=> 10 +10 / 2 #=> 5.0 + +# In Elixir gibt der Operator '/' immer einen Float-Wert zurück. + +# Für Division mit ganzzahligen Ergebnis gibt es 'div' +div(10, 2) #=> 5 + +# Um den Rest der ganzzahligen Division zu erhalten gibt es 'rem' +rem(10, 3) #=> 1 + +# Natürlich gibt es auch Operatoren für Booleans: 'or', 'and' und 'not'. Diese +# Operatoren erwarten einen Boolean als erstes Argument. +true and true #=> true +false or true #=> true +# 1 and true #=> ** (ArgumentError) argument error + +# Elixir bietet auch '||', '&&' und '!', die Argumente jedweden Typs +# akzeptieren. Alle Werte außer 'false' und 'nil' werden zu wahr evaluiert. +1 || true #=> 1 +false && 1 #=> false +nil && 20 #=> nil + +!true #=> false + +# Für Vergleiche gibt es die Operatoren `==`, `!=`, `===`, `!==`, `<=`, `>=`, +# `<` und `>` +1 == 1 #=> true +1 != 1 #=> false +1 < 2 #=> true + +# '===' und '!==' sind strikter beim Vergleich von Integern und Floats: +1 == 1.0 #=> true +1 === 1.0 #=> false + +# Es ist außerdem möglich zwei verschiedene Datentypen zu vergleichen: +1 < :hello #=> true + +# Die gesamte Ordnung über die Datentypen ist wie folgt definiert: +# number < atom < reference < functions < port < pid < tuple < list < bitstring + +# Um Joe Armstrong zu zitieren: "The actual order is not important, but that a +# total ordering is well defined is important." + +## --------------------------- +## -- Kontrollstrukturen +## --------------------------- + +# Es gibt die `if`-Verzweigung +if false do + "Dies wird nie jemand sehen..." +else + "...aber dies!" +end + +# ...und ebenso `unless` +unless true do + "Dies wird nie jemand sehen..." +else + "...aber dies!" +end + +# Du erinnerst dich an 'pattern matching'? Viele Kontrollstrukturen in Elixir +# arbeiten damit. + +# 'case' erlaubt es uns Werte mit vielerlei Mustern zu vergleichen. +case {:one, :two} do + {:four, :five} -> + "Das wird nicht passen" + {:one, x} -> + "Das schon und außerdem wird es ':two' dem Wert 'x' zuweisen." + _ -> + "Dieser Fall greift immer." +end + +# Es ist eine übliche Praxis '_' einen Wert zuzuweisen, sofern dieser Wert +# nicht weiter verwendet wird. +# Wenn wir uns zum Beispiel nur für den Kopf einer Liste interessieren: +[kopf | _] = [1,2,3] +kopf #=> 1 + +# Für bessere Lesbarkeit können wir auch das Folgende machen: +[kopf | _rest] = [:a, :b, :c] +kopf #=> :a + +# Mit 'cond' können diverse Bedingungen zur selben Zeit überprüft werden. Man +# benutzt 'cond' statt viele if-Verzweigungen zu verschachteln. +cond do + 1 + 1 == 3 -> + "Ich werde nie aufgerufen." + 2 * 5 == 12 -> + "Ich auch nicht." + 1 + 2 == 3 -> + "Aber ich!" +end + +# Es ist üblich eine letzte Bedingung einzufügen, die immer zu wahr evaluiert. +cond do + 1 + 1 == 3 -> + "Ich werde nie aufgerufen." + 2 * 5 == 12 -> + "Ich auch nicht." + true -> + "Aber ich! (dies ist im Grunde ein 'else')" +end + +# 'try/catch' wird verwendet um Werte zu fangen, die zuvor 'geworfen' wurden. +# Das Konstrukt unterstützt außerdem eine 'after'-Klausel die aufgerufen wird, +# egal ob zuvor ein Wert gefangen wurde. +try do + throw(:hello) +catch + nachricht -> "#{nachricht} gefangen." +after + IO.puts("Ich bin die 'after'-Klausel.") +end +#=> Ich bin die 'after'-Klausel. +# ":hello gefangen" + +## --------------------------- +## -- Module und Funktionen +## --------------------------- + +# Anonyme Funktionen (man beachte den Punkt) +square = fn(x) -> x * x end +square.(5) #=> 25 + +# Anonyme Funktionen unterstützen auch 'pattern' und 'guards'. Guards erlauben +# es die Mustererkennung zu justieren und werden mit dem Schlüsselwort 'when' +# eingeführt: +f = fn + x, y when x > 0 -> x + y + x, y -> x * y +end + +f.(1, 3) #=> 4 +f.(-1, 3) #=> -3 + +# Elixir bietet zahlreiche eingebaute Funktionen. Diese sind im gleichen +# Geltungsbereich ('scope') verfügbar. +is_number(10) #=> true +is_list("hello") #=> false +elem({1,2,3}, 0) #=> 1 + +# Mehrere Funktionen können in einem Modul gruppiert werden. Innerhalb eines +# Moduls ist es möglich mit dem Schlüsselwort 'def' eine Funktion zu +# definieren. +defmodule Math do + def sum(a, b) do + a + b + end + + def square(x) do + x * x + end +end + +Math.sum(1, 2) #=> 3 +Math.square(3) #=> 9 + +# Um unser einfaches Mathe-Modul zu kompilieren muss es unter 'math.ex' +# gesichert werden. Anschließend kann es mit 'elixirc' im Terminal aufgerufen +# werden: elixirc math.ex + +# Innerhalb eines Moduls definieren wir private Funktionen mit 'defp'. Eine +# Funktion, die mit 'def' erstellt wurde, kann von anderen Modulen aufgerufen +# werden; eine private Funktion kann nur lokal angesprochen werden. +defmodule PrivateMath do + def sum(a, b) do + do_sum(a, b) + end + + defp do_sum(a, b) do + a + b + end +end + +PrivateMath.sum(1, 2) #=> 3 +# PrivateMath.do_sum(1, 2) #=> ** (UndefinedFunctionError) + +# Auch Funktionsdeklarationen unterstützen 'guards' und Mustererkennung: +defmodule Geometry do + def area({:rectangle, w, h}) do + w * h + end + + def area({:circle, r}) when is_number(r) do + 3.14 * r * r + end +end + +Geometry.area({:rectangle, 2, 3}) #=> 6 +Geometry.area({:circle, 3}) #=> 28.25999999999999801048 +# Geometry.area({:circle, "not_a_number"}) +#=> ** (FunctionClauseError) no function clause matching in Geometry.area/1 + +# Wegen der Unveränderlichkeit von Variablen ist Rekursion ein wichtiger +# Bestandteil von Elixir. +defmodule Recursion do + def sum_list([head | tail], acc) do + sum_list(tail, acc + head) + end + + def sum_list([], acc) do + acc + end +end + +Recursion.sum_list([1,2,3], 0) #=> 6 + +# Elixir-Module unterstützen Attribute. Es gibt eingebaute Attribute, ebenso +# ist es möglich eigene Attribute hinzuzufügen. +defmodule MyMod do + @moduledoc """ + Dies ist ein eingebautes Attribut in einem Beispiel-Modul + """ + + @my_data 100 # Dies ist ein selbst-definiertes Attribut. + IO.inspect(@my_data) #=> 100 +end + +## --------------------------- +## -- 'Records' und Ausnahmebehandlung +## --------------------------- + +# 'Records' sind im Grunde Strukturen, die es erlauben einem Wert einen eigenen +# Namen zuzuweisen. +defrecord Person, name: nil, age: 0, height: 0 + +joe_info = Person.new(name: "Joe", age: 30, height: 180) +#=> Person[name: "Joe", age: 30, height: 180] + +# Zugriff auf den Wert von 'name' +joe_info.name #=> "Joe" + +# Den Wert von 'age' überschreiben +joe_info = joe_info.age(31) #=> Person[name: "Joe", age: 31, height: 180] + +# Der 'try'-Block wird zusammen mit dem 'rescue'-Schlüsselwort dazu verwendet, +# um Ausnahmen beziehungsweise Fehler zu behandeln. +try do + raise "Irgendein Fehler." +rescue + RuntimeError -> "Laufzeit-Fehler gefangen." + _error -> "Und dies fängt jeden Fehler." +end + +# Alle Ausnahmen haben das Attribut 'message' +try do + raise "ein Fehler" +rescue + x in [RuntimeError] -> + x.message +end + +## --------------------------- +## -- Nebenläufigkeit +## --------------------------- + +# Elixir beruht auf dem Aktoren-Model zur Behandlung der Nebenläufigkeit. Alles +# was man braucht um in Elixir nebenläufige Programme zu schreiben sind drei +# Primitive: Prozesse erzeugen, Nachrichten senden und Nachrichten empfangen. + +# Um einen neuen Prozess zu erzeugen nutzen wir die 'spawn'-Funktion, die +# wiederum eine Funktion als Argument entgegen nimmt. +f = fn -> 2 * 2 end #=> #Function +spawn(f) #=> #PID<0.40.0> + +# 'spawn' gibt eine pid (einen Identifikator des Prozesses) zurück. Diese kann +# nun verwendet werden, um Nachrichten an den Prozess zu senden. Um +# zu senden nutzen wir den '<-' Operator. Damit das alles Sinn macht müssen wir +# in der Lage sein Nachrichten zu empfangen. Dies wird mit dem +# 'receive'-Mechanismus sichergestellt: +defmodule Geometry do + def area_loop do + receive do + {:rectangle, w, h} -> + IO.puts("Area = #{w * h}") + area_loop() + {:circle, r} -> + IO.puts("Area = #{3.14 * r * r}") + area_loop() + end + end +end + +# Kompiliere das Modul, starte einen Prozess und gib die 'area_loop' Funktion +# in der Shell mit, etwa so: +pid = spawn(fn -> Geometry.area_loop() end) #=> #PID<0.40.0> + +# Sende eine Nachricht an die 'pid', die ein Muster im 'receive'-Ausdruck +# erfüllt: +pid <- {:rectangle, 2, 3} +#=> Area = 6 +# {:rectangle,2,3} + +pid <- {:circle, 2} +#=> Area = 12.56000000000000049738 +# {:circle,2} + +# Die Shell selbst ist ein Prozess und mit dem Schlüsselwort 'self' kann man +# die aktuelle pid herausfinden. +self() #=> #PID<0.27.0> + +``` + +## Referenzen und weitere Lektüre + +* [Getting started guide](http://elixir-lang.org/getting_started/1.html) auf der [elixir Website](http://elixir-lang.org) +* [Elixir Documentation](http://elixir-lang.org/docs/master/) +* ["Learn You Some Erlang for Great Good!"](http://learnyousomeerlang.com/) von Fred Hebert +* "Programming Erlang: Software for a Concurrent World" von Joe Armstrong diff --git a/de-de/javascript-de.html.markdown b/de-de/javascript-de.html.markdown index f817ee9f..a71d4316 100644 --- a/de-de/javascript-de.html.markdown +++ b/de-de/javascript-de.html.markdown @@ -1,525 +1,525 @@ ---- -language: javascript -contributors: - - ["Leigh Brenecki", "https://leigh.net.au"] -translators: - - ["ggb", "http://www.ideen-und-soehne.de"] -filename: learnjavascript-de.js -lang: de-de ---- - -(Anmerkungen des Original-Autors:) -JavaScript wurde im Jahr 1995 von Brendan Eich bei Netscape entwickelt. Ursprünglich war es als einfachere Skriptsprache für Websites gedacht, ergänzend zu Java, das für komplexere Webanwendungen verwendet wird. Die enge Integration in Websites und der in Browser eingebaute Support der Sprache haben dafür gesorgt, dass JavaScript weit häufiger für Web-Frontends verwendet wird als Java. - -Dabei ist JavaScript inzwischen nicht mehr auf Browser beschränkt: Node.js, ein Projekt, das eine eigene Laufzeitumgebung auf Grundlage von Google Chromes V8 mitbringt, wird derzeit immer populärer. - -Feedback ist herzlich Willkommen! Der ursprüngliche Autor ist unter [@excitedleigh](https://twitter.com/excitedleigh) oder [l@leigh.net.au](mailto:l@leigh.net.au) zu erreichen. Der Übersetzer unter [gregorbg@web.de](mailto:gregorbg@web.de). - -```js -// Kommentare werden wie in C gesetzt: Einzeilige Kommentare starten mit zwei -// Slashes -/* während mehrzeilige Kommentare mit einem -Slash und einem Stern anfangen und enden */ - -// Statements können mit einem Semikolon beendet werden -machWas(); - -// ...müssen sie aber nicht, weil Semikola automatisch eingefügt werden, wenn -// eine neue Zeile beginnt, abgesehen von einigen Ausnahmen. -machWas() - -// Obwohl wir uns für den Anfang nicht um diese Ausnahmen kümmern müssen ist -// es besser die Semikola immer zu setzen. - -/////////////////////////////////// -// 1. Nummern, Strings und Operationen - -// JavaScript hat einen Nummern-Typ (64-bit IEEE 754 double). -3; // = 3 -1.5; // = 1.5 - -// Beinahe alle grundlegenden arithmetischen Operationen arbeiten wie erwartet. -1 + 1; // = 2 -0.1 + 0.2; // = 0.30000000000000004 -10 * 2; // = 20 -35 / 5; // = 7 - -// Division funktioniert auch mit einem Ergebnis nach dem Komma. -5 / 2; // = 2.5 - -// Bit-weise Operationen sind auch möglich; wenn eine Bit-weise Operation -// ausgeführt wird, wird die Fließkomma-Zahl in einen 32-bit Integer (mit -// Vorzeichen) umgewandelt. -1 << 2; // = 4 - -// Die Rangfolge der Operationen kann mit Klammern erzwungen werden. -(1 + 3) * 2; // = 8 - -// Es gibt drei spezielle, nicht-reale Nummern-Werte: -Infinity; // Ergebnis von z. B. 1 / 0 --Infinity; // Ergebnis von z. B. -1 / 0 -NaN; // Ergebnis von z. B. 0 / 0 - -// Es gibt auch einen Boolean-Typ (für Wahrheitswerte). -true; -false; - -// Strings werden mit ' oder " erzeugt. -'abc'; -"Hello, world"; - -// Für die Negation wird das ! benutzt. -!true; // = false -!false; // = true - -// Gleichheit wird mit === geprüft. -1 === 1; // = true -2 === 1; // = false - -// Ungleichheit wird mit !== überprüft. -1 !== 1; // = false -2 !== 1; // = true - -// Andere Vergleichsoperatoren sind -1 < 10; // = true -1 > 10; // = false -2 <= 2; // = true -2 >= 2; // = true - -// Strings können mit + verbunden -"Hello " + "world!"; // = "Hello world!" - -// und mit < und > verglichen werden. -"a" < "b"; // = true - -// Für den Vergleich von Werten mit "==" wird eine Typumwandlung erzwungen... -"5" == 5; // = true - -// ...solange man nicht === verwendet. -"5" === 5; // = false - -// Auf einzelne Buchstaben innerhalb eines Strings kann mit der Methode -// 'charAt' zugegriffen werden -"This is a string".charAt(0); // = "T" - -// Die Methode 'substring' gibt Teilbereiche eines Strings zurück -"Hello world".substring(0, 5); // = "Hello" - -// 'length' ist eine Eigenschaft und wird folglich ohne '()' benutzt -"Hello".length; // = 5 - -// Es gibt außerdem die Werte 'null' und 'undefined' -null; // wird verwendet um einen vorsätzlich gewählten 'Nicht'-Wert anzuzeigen -undefined; // wird verwendet um anzuzeigen, dass der Wert (aktuell) nicht - // verfügbar ist (obwohl genau genommen undefined selbst einen Wert - // darstellt) - -// false, null, undefined, NaN, 0 und "" sind 'falsy', d. h. alles andere ist -// wahr. Man beachte, dass 0 falsch und "0" wahr ist, obwohl 0 == "0". - -/////////////////////////////////// -// 2. Variablen, Arrays und Objekte - -// Variablen werden mit dem Schlüsselwort 'var' und einem frei wählbaren -// Bezeichner deklariert. JavaScript ist dynamisch typisiert, so dass man einer -// Variable keinen Typ zuweisen muss. Die Zuweisung verwendet ein einfaches =. -var einWert = 5; - - // Wenn man das Schlüsselwort 'var' weglässt, bekommt man keinen Fehler -einAndererWert = 10; - -// ...aber die Variable wird im globalen Kontext erzeugt, nicht in dem Kontext, -// in dem sie erzeugt wurde. - -// Variablen die erzeugt wurden ohne ihnen einen Wert zuzuweisen, erhalten den -// Wert 'undefined'. -var einDritterWert; // = undefined - -// Es existiert eine Kurzform, um mathematische Operationen mit Variablen -// auszuführen: -einWert += 5; // äquivalent zu einWert = einWert + 5; einWert ist nun also 10 -einWert *= 10; // einWert ist nach dieser Operation 100 - -// Und es existiert eine weitere, sogar noch kürzere Form, um 1 zu addieren -// oder zu subtrahieren -einWert++; // nun ist einWert 101 -einWert--; // wieder 100 - -// Arrays sind geordnete Listen von Werten irgendeines Typs -var myArray = ["Hello", 45, true]; - -// Auf einzelne Elemente eines Arrays kann zugegriffen werden, in dem der Index -// in eckigen Klammern hinter das Array geschrieben werden. Die Indexierung -// beginnt bei 0. -myArray[1]; // = 45 - -// Arrays haben keine feste Länge -myArray.push("World"); -myArray.length; // = 4 - -// und sind veränderlich -myArray[3] = "Hello"; - -// Die Objekte in JavaScript entsprechen 'dictionaries' oder 'maps' in anderen -// Sprachen: es handelt sich um ungeordnete Schlüssel-Wert-Paare. -var myObj = { key1: "Hello", key2: "World" }; - -// Schlüssel sind Strings, aber es werden keine Anführungszeichen benötigt, -// sofern es sich um reguläre JavaScript-Bezeichner handelt. Werte können von -// jedem Typ sein. -var myObj = { myKey: "myValue", "my other key": 4 }; - -// Auf Attribute von Objekten kann ebenfalls mit eckigen Klammern zugegriffen -// werden, -myObj["my other key"]; // = 4 - -// ... oder in dem man die Punkt-Notation verwendet, vorausgesetzt es handelt -// sich bei dem Schlüssel um einen validen Bezeichner. -myObj.myKey; // = "myValue" - -// Objekte sind veränderlich, Werte können verändert und neue Schlüssel -// hinzugefügt werden. -myObj.myThirdKey = true; - -// Der Zugriff auf einen noch nicht definierten Schlüssel, liefert ein -// undefined. -myObj.myFourthKey; // = undefined - -/////////////////////////////////// -// 3. Logik und Kontrollstrukturen - -// Die if-Struktur arbeitet, wie man es erwartet. -var count = 1; -if (count == 3){ - // wird evaluiert, wenn count gleich 3 ist -} else if (count == 4) { - // wird evaluiert, wenn count gleich 4 ist -} else { - // wird evaluiert, wenn es weder 3 noch 4 ist -} - -// Genauso 'while'. -while (true) { - // Eine unendliche Schleife! -} - -// Do-while-Scheifen arbeiten wie while-Schleifen, abgesehen davon, dass sie -// immer mindestens einmal ausgeführt werden. -var input; -do { - input = getInput(); -} while ( !isValid( input ) ) - -// Die for-Schleife arbeitet genau wie in C und Java: -// Initialisierung; Bedingung, unter der die Ausführung fortgesetzt wird; -// Iteration. -for ( var i = 0; i < 5; i++ ) { - // wird 5-mal ausgeführt -} - -// '&&' ist das logische und, '||' ist das logische oder -if (house.size == "big" && house.colour == "blue"){ - house.contains = "bear"; - // Die Größe des Hauses ist groß und die Farbe blau. -} -if (colour == "red" || colour == "blue"){ - // Die Farbe ist entweder rot oder blau. -} - -// Die Auswertung von '&&' und '||' erfolgt so, dass abgebrochen wird, wenn die -// Bedingung erfüllt ist (bei oder) oder nicht-erfüllt ist (bei und). Das ist -// nützlich, um einen Default-Wert zu setzen. -var name = otherName || "default"; - -// Ein 'switch' Statement prüft Gleichheit mit === -// ohne ein 'break' nach jedem Fall -// werden auch die Fälle nach dem korrekten aufgerufen -grade = 'B'; -switch (grade) { - case 'A': - console.log("Great job"); - break; - case 'B': - console.log("OK job"); - break; - case 'C': - console.log("You can do better"); - break; - default: - console.log("Oy vey"); - break; -} - -/////////////////////////////////// -// 4. Funktionen, Geltungsbereich und Closures - -// In JavaScript werden Funktionen mit dem Schlüsselwort 'function' deklariert. -function myFunction(thing){ - return thing.toUpperCase(); -} -myFunction("foo"); // = "FOO" - -// Vorsicht: der Ausdruck der den Rückgabewert einer Funktion bildet muss -// auf der selben Zeile beginnen auf der auch das 'return' Keyword steht -// Sonst wird hier ein automatisches Semikolon eingefügt und die Funktion -// gibt 'undefined' zurück -function myFunction() -{ - return // <- Hier wird automatisch ein Semikolon eingefügt - { - thisIsAn: 'object literal' - } -} -myFunction(); // = undefined - -// In JavaScript sind Funktionen 'Bürger erster Klasse', also können sie wie -// Variablen verwendet und als Parameter anderen Funktionen übergeben werden -// - zum Beispiel, um einen 'event handler' zu 'beliefern'. -function myFunction() { - // wird ausgeführt, nachdem 5 Sekunden vergangen sind -} -setTimeout(myFunction, 5000); - -// Funktionen können auch deklariert werden, ohne ihnen einen Namen zuzuweisen. -// Es ist möglich diese anonymen Funktionen direkt als (oder im) Argument -// einer anderen Funktion zu definieren. -setTimeout(function(){ - // wird ausgeführt, nachdem 5 Sekunden vergangen sind -}, 5000); - -// JavaScript hat einen Geltungsbereich, der sich auf Funktionen erstreckt: -// Funktionen haben ihren eigenen Geltungsbereich, andere Blöcke nicht. -if(true) { - var i = 5; -} -i; // = 5 - nicht undefined, wie man es von einer Sprache erwarten würde, die - // ihren Geltungsbereich nach Blöcken richtet - -// Daraus ergibt sich ein bestimmtes Muster für sofort-ausführbare, anonyme -// Funktionen, die es vermeiden, dass der globale Geltungsbereich von Variablen -// 'verschmutzt' wird. -(function(){ - var temporary = 5; - // Auf eine Variable im globalen Geltungsbereich kann zugegriffen werden, - // sofern sie im globalen Objekt definiert ist (in einem Webbrowser ist - // dies immer das 'window'-Objekt, in anderen Umgebungen, bspw. Node.js, - // kann das anders aussehen). - window.permanent = 10; -})(); -temporary; // wirft einen ReferenceError -permanent; // = 10 - -// Eines der mächtigsten Charakteristika von JavaScript sind Closures. Wird -// eine Funktion innerhalb einer anderen Funktion definiert, dann hat die -// innere Funktion Zugriff auf alle Variablen der äußeren Funktion, sogar dann, -// wenn die äußere Funktion beendet wurde. -function sayHelloInFiveSeconds(name){ - var prompt = "Hello, " + name + "!"; - function inner(){ - alert(prompt); - } - setTimeout(inner, 5000); - // setTimeout wird asynchron ausgeführt. Also wird sayHelloInFiveSeconds - // sofort verlassen und setTimeout wird die innere Funktion 'im nachhinein' - // aufrufen. Dennoch: Weil sayHelloInFiveSeconds eine Hülle um die innere - // Funktion bildet, hat die innere Funktion immer noch Zugriff auf die - // Variable prompt. -} -sayHelloInFiveSeconds("Adam"); // wird nach 5 Sekunden ein Popup mit der - // Nachricht "Hello, Adam!" öffnen. - -/////////////////////////////////// -// 5. Mehr über Objekte, Konstruktoren und Prototypen - -// Objekte können Funktionen enthalten. -var myObj = { - myFunc: function(){ - return "Hello world!"; - } -}; -myObj.myFunc(); // = "Hello world!" - -// Wenn Funktionen aufgerufen werden, die zu einem Objekt gehören, können sie -// auf das eigene Objekt mit dem Schlüsselwort 'this' zugreifen. -myObj = { - myString: "Hello world!", - myFunc: function(){ - return this.myString; - } -}; -myObj.myFunc(); // = "Hello world!" - -// Worauf 'this' gesetzt wird, ist davon abhängig, wie die Funktion aufgerufen -// wird, nicht wo sie definiert wurde. Unsere Funktion wird daher nicht -// funktionieren, sofern sie außerhalb des Kontextes des Objekts aufgerufen -// wird. -var myFunc = myObj.myFunc; -myFunc(); // = undefined - -// Umgekehrt ist es möglich eine Funktion einem Objekt zuzuweisen und dadurch -// Zugriff auf den this-Kontext zu erhalten, sogar dann, wenn die Funktion dem -// Objekt nach dessen Definition zugewiesen wird. -var myOtherFunc = function(){ - return this.myString.toUpperCase(); -} -myObj.myOtherFunc = myOtherFunc; -myObj.myOtherFunc(); // = "HELLO WORLD!" - -// Mit den Methoden 'call' und 'apply' kann der Kontext eines Funktionsaufrufs -// verändert werden - -var anotherFunc = function(s){ - return this.myString + s; -} -anotherFunc.call(myObj, " And Hello Moon!"); // = "Hello World! And Hello Moon!" - -// 'apply' funktioniert beiahe identisch, erwartet die übergebenen Argumente -// aber in einem Array - -anotherFunc.apply(myObj, [" And Hello Sun!"]); // = "Hello World! And Hello Sun!" - -// Das ist hilfreich wenn man einer Funktion eine beliebige Zahl Argumente -// übergeben kann - -Math.min(42, 6, 27); // = 6 -Math.min([42, 6, 27]); // = NaN (uh-oh!) -Math.min.apply(Math, [42, 6, 27]); // = 6 - -// 'call' und 'apply' beeinflussen aber nur den spezifischen Aufruf. -// Um den Kontext einer Funktion dauerhaft zu ändern wird 'bind' benutzt. - -var boundFunc = anotherFunc.bind(myObj); -boundFunc(" And Hello Saturn!"); // = "Hello World! And Hello Saturn!" - -// Mit 'bind' lassen sich Funktionen auch teilweise anwenden / "curryen". -var product = function(a, b){ return a * b; } -var doubler = product.bind(this, 2); -doubler(8); // = 16 - -// Wenn eine Funktion mit dem Schlüsselwort 'new' aufgerufen wird, dann wird -// ein neues Objekt erzeugt. Funktionen, die darauf ausgelegt sind in dieser -// Art aufgerufen zu werden, werden Konstruktoren genannt. -var MyConstructor = function(){ - this.myNumber = 5; -} -myNewObj = new MyConstructor(); // = {myNumber: 5} -myNewObj.myNumber; // = 5 - -// Jedes JavaScript-Objekt hat einen Prototyp. Wenn man versucht auf eine -// Eigenschaft des Objekts zuzugreifen, das nicht im Objekt selbst existiert, -// schaut der Interpreter in dessen Prototyp nach. - -// Einige JavaScript-Implementierungen erlauben den direkten Zugriff auf den -// Prototyp eines Objekts durch die magische Eigenschaft __proto__. Obwohl das -// nützlich ist, um Prototypen im Allgemeinen zu erklären, ist das nicht Teil -// des Standards; zum Standard-Weg der Nutzung von Prototypen kommen wir -// später. -var myObj = { - myString: "Hello world!", -}; -var myPrototype = { - meaningOfLife: 42, - myFunc: function(){ - return this.myString.toLowerCase() - } -}; -myObj.__proto__ = myPrototype; -myObj.meaningOfLife; // = 42 - -// Das funktioniert auch bei Funktionen. -myObj.myFunc(); // = "hello world!" - -// Sollte die Eigenschaft nicht im Prototypen des Objekts enthalten sein, dann -// wird im Prototypen des Prototypen nachgesehen und so weiter. -myPrototype.__proto__ = { - myBoolean: true -}; -myObj.myBoolean; // = true - -// Dafür wird nichts hin und her kopiert; jedes Objekt speichert eine Referenz -// auf seinen Prototypen. Das heißt wenn der Prototyp geändert wird, dann -// werden die Änderungen überall sichtbar. -myPrototype.meaningOfLife = 43; -myObj.meaningOfLife; // = 43 - -// Es wurde bereits erwähnt, dass __proto__ nicht zum Standard gehört und es -// gibt ebenso keinen Standard-Weg, um den Prototyp eines existierenden Objekts -// zu ändern. Es gibt dennoch zwei Wege, wie man ein neues Objekt mit einem -// gegebenen Prototypen erzeugt. - -// Der erste Weg ist die Methode Object.create, die eine jüngere Ergänzung des -// JavaScript-Standards ist und daher noch nicht in allen Implementierungen -// verfügbar. -var myObj = Object.create(myPrototype); -myObj.meaningOfLife; // = 43 - -// Der zweite Weg, der immer funktioniert, hat mit den Konstruktoren zu tun. -// Konstruktoren haben eine Eigenschaft, die Prototyp heißt. Dabei handelt es -// sich *nicht* um den Prototypen der Konstruktor-Funktion; stattdessen handelt -// es sich um den Prototypen, der einem neuen Objekt mitgegeben wird, wenn es -// mit dem Konstruktor und dem Schlüsselwort 'new' erzeugt wird. -MyConstructor.prototype = { - getMyNumber: function(){ - return this.myNumber - } -}; -var myNewObj2 = new MyConstructor(); -myNewObj2.getMyNumber(); // = 5 - -// Alle primitiven Typen, also strings und numbers, haben auch Konstruktoren, -// die zu dem Typ äquivalente Wrapper-Objekte erzeugen. -var myNumber = 12; -var myNumberObj = new Number(12); -myNumber == myNumberObj; // = true - -// Genau genommen: Sie sind nicht exakt äquivalent. -typeof myNumber; // = 'number' -typeof myNumberObj; // = 'object' -myNumber === myNumberObj; // = false -if (0){ - // Dieser Teil wird nicht ausgeführt, weil 0 'falsy' ist. -} - -// Das Wrapper-Objekt und die regulären, eingebauten Typen, teilen sich einen -// Prototyp; so ist es möglich zum Beispiel einem String weitere Funktionen -// hinzuzufügen. -String.prototype.firstCharacter = function(){ - return this.charAt(0); -} -"abc".firstCharacter(); // = "a" - -// Diese Tatsache wird häufig bei einer Methode mit dem Namen 'polyfilling' -// verwendet: Dabei wird ein neues Feature von JavaScript in einer älteren -// Untermenge der Sprache integriert, so dass bestimmte Funktionen auch in -// älteren Umgebungen und Browsern verwendet werden können. - -// Ein Beispiel: Es wurde erwähnt, dass die Methode Object.create nicht in -// allen Umgebungen verfügbar ist - wir können sie dennoch verwenden, mit einem -// 'polyfill': -if (Object.create === undefined){ // überschreib nichts, was eventuell bereits - // existiert - Object.create = function(proto){ - // erstelle einen vorübergehenden Konstruktor mit dem richtigen - // Prototypen - var Constructor = function(){}; - Constructor.prototype = proto; - // verwende es dann, um ein neues Objekt mit einem passenden - // Prototypen zurückzugeben - return new Constructor(); - } -} -``` - -## Zur weiteren Lektüre (englisch) - -Das [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/JavaScript) bietet eine ausgezeichnete Dokumentation für die Verwendung von JavaScript im Browser. Es ist außerdem ein Wiki und ermöglicht es damit anderen zu helfen, wenn man selbst ein wenig Wissen angesammelt hat. - -MDN's [A re-introduction to JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) führt sehr viele der hier vorgestellten Konzepte im Detail aus. - -Dieses Tutorial hat nur die Sprache JavaScript vorgestellt; um mehr über den Einsatz in Websites zu lernen, ist es ein guter Start etwas über das [Document Object Model](https://developer.mozilla.org/en-US/docs/Using_the_W3C_DOM_Level_1_Core) zu lernen. - -[JavaScript Garden](http://bonsaiden.github.io/JavaScript-Garden/) ist eine tiefgehende Einführung in die kontra-intuitiven Parts der Sprache. - -[JavaScript: The Definitive Guide](http://www.amazon.com/gp/product/0596805527/) ist ein Klassiker unter den Referenzen. - -Zusätzlich zu direkten Beiträgen zu diesem Artikel ist der Inhalt in Anlehnung an Louie Dinh's Python-Tutorial auf dieser Seite und das [JS Tutorial](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) des Mozilla Developer Network entstanden. +--- +language: javascript +contributors: + - ["Leigh Brenecki", "https://leigh.net.au"] +translators: + - ["ggb", "http://www.ideen-und-soehne.de"] +filename: learnjavascript-de.js +lang: de-de +--- + +(Anmerkungen des Original-Autors:) +JavaScript wurde im Jahr 1995 von Brendan Eich bei Netscape entwickelt. Ursprünglich war es als einfachere Skriptsprache für Websites gedacht, ergänzend zu Java, das für komplexere Webanwendungen verwendet wird. Die enge Integration in Websites und der in Browser eingebaute Support der Sprache haben dafür gesorgt, dass JavaScript weit häufiger für Web-Frontends verwendet wird als Java. + +Dabei ist JavaScript inzwischen nicht mehr auf Browser beschränkt: Node.js, ein Projekt, das eine eigene Laufzeitumgebung auf Grundlage von Google Chromes V8 mitbringt, wird derzeit immer populärer. + +Feedback ist herzlich Willkommen! Der ursprüngliche Autor ist unter [@excitedleigh](https://twitter.com/excitedleigh) oder [l@leigh.net.au](mailto:l@leigh.net.au) zu erreichen. Der Übersetzer unter [gregorbg@web.de](mailto:gregorbg@web.de). + +```js +// Kommentare werden wie in C gesetzt: Einzeilige Kommentare starten mit zwei +// Slashes +/* während mehrzeilige Kommentare mit einem +Slash und einem Stern anfangen und enden */ + +// Statements können mit einem Semikolon beendet werden +machWas(); + +// ...müssen sie aber nicht, weil Semikola automatisch eingefügt werden, wenn +// eine neue Zeile beginnt, abgesehen von einigen Ausnahmen. +machWas() + +// Obwohl wir uns für den Anfang nicht um diese Ausnahmen kümmern müssen ist +// es besser die Semikola immer zu setzen. + +/////////////////////////////////// +// 1. Nummern, Strings und Operationen + +// JavaScript hat einen Nummern-Typ (64-bit IEEE 754 double). +3; // = 3 +1.5; // = 1.5 + +// Beinahe alle grundlegenden arithmetischen Operationen arbeiten wie erwartet. +1 + 1; // = 2 +0.1 + 0.2; // = 0.30000000000000004 +10 * 2; // = 20 +35 / 5; // = 7 + +// Division funktioniert auch mit einem Ergebnis nach dem Komma. +5 / 2; // = 2.5 + +// Bit-weise Operationen sind auch möglich; wenn eine Bit-weise Operation +// ausgeführt wird, wird die Fließkomma-Zahl in einen 32-bit Integer (mit +// Vorzeichen) umgewandelt. +1 << 2; // = 4 + +// Die Rangfolge der Operationen kann mit Klammern erzwungen werden. +(1 + 3) * 2; // = 8 + +// Es gibt drei spezielle, nicht-reale Nummern-Werte: +Infinity; // Ergebnis von z. B. 1 / 0 +-Infinity; // Ergebnis von z. B. -1 / 0 +NaN; // Ergebnis von z. B. 0 / 0 + +// Es gibt auch einen Boolean-Typ (für Wahrheitswerte). +true; +false; + +// Strings werden mit ' oder " erzeugt. +'abc'; +"Hello, world"; + +// Für die Negation wird das ! benutzt. +!true; // = false +!false; // = true + +// Gleichheit wird mit === geprüft. +1 === 1; // = true +2 === 1; // = false + +// Ungleichheit wird mit !== überprüft. +1 !== 1; // = false +2 !== 1; // = true + +// Andere Vergleichsoperatoren sind +1 < 10; // = true +1 > 10; // = false +2 <= 2; // = true +2 >= 2; // = true + +// Strings können mit + verbunden +"Hello " + "world!"; // = "Hello world!" + +// und mit < und > verglichen werden. +"a" < "b"; // = true + +// Für den Vergleich von Werten mit "==" wird eine Typumwandlung erzwungen... +"5" == 5; // = true + +// ...solange man nicht === verwendet. +"5" === 5; // = false + +// Auf einzelne Buchstaben innerhalb eines Strings kann mit der Methode +// 'charAt' zugegriffen werden +"This is a string".charAt(0); // = "T" + +// Die Methode 'substring' gibt Teilbereiche eines Strings zurück +"Hello world".substring(0, 5); // = "Hello" + +// 'length' ist eine Eigenschaft und wird folglich ohne '()' benutzt +"Hello".length; // = 5 + +// Es gibt außerdem die Werte 'null' und 'undefined' +null; // wird verwendet um einen vorsätzlich gewählten 'Nicht'-Wert anzuzeigen +undefined; // wird verwendet um anzuzeigen, dass der Wert (aktuell) nicht + // verfügbar ist (obwohl genau genommen undefined selbst einen Wert + // darstellt) + +// false, null, undefined, NaN, 0 und "" sind 'falsy', d. h. alles andere ist +// wahr. Man beachte, dass 0 falsch und "0" wahr ist, obwohl 0 == "0". + +/////////////////////////////////// +// 2. Variablen, Arrays und Objekte + +// Variablen werden mit dem Schlüsselwort 'var' und einem frei wählbaren +// Bezeichner deklariert. JavaScript ist dynamisch typisiert, so dass man einer +// Variable keinen Typ zuweisen muss. Die Zuweisung verwendet ein einfaches =. +var einWert = 5; + + // Wenn man das Schlüsselwort 'var' weglässt, bekommt man keinen Fehler +einAndererWert = 10; + +// ...aber die Variable wird im globalen Kontext erzeugt, nicht in dem Kontext, +// in dem sie erzeugt wurde. + +// Variablen die erzeugt wurden ohne ihnen einen Wert zuzuweisen, erhalten den +// Wert 'undefined'. +var einDritterWert; // = undefined + +// Es existiert eine Kurzform, um mathematische Operationen mit Variablen +// auszuführen: +einWert += 5; // äquivalent zu einWert = einWert + 5; einWert ist nun also 10 +einWert *= 10; // einWert ist nach dieser Operation 100 + +// Und es existiert eine weitere, sogar noch kürzere Form, um 1 zu addieren +// oder zu subtrahieren +einWert++; // nun ist einWert 101 +einWert--; // wieder 100 + +// Arrays sind geordnete Listen von Werten irgendeines Typs +var myArray = ["Hello", 45, true]; + +// Auf einzelne Elemente eines Arrays kann zugegriffen werden, in dem der Index +// in eckigen Klammern hinter das Array geschrieben werden. Die Indexierung +// beginnt bei 0. +myArray[1]; // = 45 + +// Arrays haben keine feste Länge +myArray.push("World"); +myArray.length; // = 4 + +// und sind veränderlich +myArray[3] = "Hello"; + +// Die Objekte in JavaScript entsprechen 'dictionaries' oder 'maps' in anderen +// Sprachen: es handelt sich um ungeordnete Schlüssel-Wert-Paare. +var myObj = { key1: "Hello", key2: "World" }; + +// Schlüssel sind Strings, aber es werden keine Anführungszeichen benötigt, +// sofern es sich um reguläre JavaScript-Bezeichner handelt. Werte können von +// jedem Typ sein. +var myObj = { myKey: "myValue", "my other key": 4 }; + +// Auf Attribute von Objekten kann ebenfalls mit eckigen Klammern zugegriffen +// werden, +myObj["my other key"]; // = 4 + +// ... oder in dem man die Punkt-Notation verwendet, vorausgesetzt es handelt +// sich bei dem Schlüssel um einen validen Bezeichner. +myObj.myKey; // = "myValue" + +// Objekte sind veränderlich, Werte können verändert und neue Schlüssel +// hinzugefügt werden. +myObj.myThirdKey = true; + +// Der Zugriff auf einen noch nicht definierten Schlüssel, liefert ein +// undefined. +myObj.myFourthKey; // = undefined + +/////////////////////////////////// +// 3. Logik und Kontrollstrukturen + +// Die if-Struktur arbeitet, wie man es erwartet. +var count = 1; +if (count == 3){ + // wird evaluiert, wenn count gleich 3 ist +} else if (count == 4) { + // wird evaluiert, wenn count gleich 4 ist +} else { + // wird evaluiert, wenn es weder 3 noch 4 ist +} + +// Genauso 'while'. +while (true) { + // Eine unendliche Schleife! +} + +// Do-while-Scheifen arbeiten wie while-Schleifen, abgesehen davon, dass sie +// immer mindestens einmal ausgeführt werden. +var input; +do { + input = getInput(); +} while ( !isValid( input ) ) + +// Die for-Schleife arbeitet genau wie in C und Java: +// Initialisierung; Bedingung, unter der die Ausführung fortgesetzt wird; +// Iteration. +for ( var i = 0; i < 5; i++ ) { + // wird 5-mal ausgeführt +} + +// '&&' ist das logische und, '||' ist das logische oder +if (house.size == "big" && house.colour == "blue"){ + house.contains = "bear"; + // Die Größe des Hauses ist groß und die Farbe blau. +} +if (colour == "red" || colour == "blue"){ + // Die Farbe ist entweder rot oder blau. +} + +// Die Auswertung von '&&' und '||' erfolgt so, dass abgebrochen wird, wenn die +// Bedingung erfüllt ist (bei oder) oder nicht-erfüllt ist (bei und). Das ist +// nützlich, um einen Default-Wert zu setzen. +var name = otherName || "default"; + +// Ein 'switch' Statement prüft Gleichheit mit === +// ohne ein 'break' nach jedem Fall +// werden auch die Fälle nach dem korrekten aufgerufen +grade = 'B'; +switch (grade) { + case 'A': + console.log("Great job"); + break; + case 'B': + console.log("OK job"); + break; + case 'C': + console.log("You can do better"); + break; + default: + console.log("Oy vey"); + break; +} + +/////////////////////////////////// +// 4. Funktionen, Geltungsbereich und Closures + +// In JavaScript werden Funktionen mit dem Schlüsselwort 'function' deklariert. +function myFunction(thing){ + return thing.toUpperCase(); +} +myFunction("foo"); // = "FOO" + +// Vorsicht: der Ausdruck der den Rückgabewert einer Funktion bildet muss +// auf der selben Zeile beginnen auf der auch das 'return' Keyword steht +// Sonst wird hier ein automatisches Semikolon eingefügt und die Funktion +// gibt 'undefined' zurück +function myFunction() +{ + return // <- Hier wird automatisch ein Semikolon eingefügt + { + thisIsAn: 'object literal' + } +} +myFunction(); // = undefined + +// In JavaScript sind Funktionen 'Bürger erster Klasse', also können sie wie +// Variablen verwendet und als Parameter anderen Funktionen übergeben werden +// - zum Beispiel, um einen 'event handler' zu 'beliefern'. +function myFunction() { + // wird ausgeführt, nachdem 5 Sekunden vergangen sind +} +setTimeout(myFunction, 5000); + +// Funktionen können auch deklariert werden, ohne ihnen einen Namen zuzuweisen. +// Es ist möglich diese anonymen Funktionen direkt als (oder im) Argument +// einer anderen Funktion zu definieren. +setTimeout(function(){ + // wird ausgeführt, nachdem 5 Sekunden vergangen sind +}, 5000); + +// JavaScript hat einen Geltungsbereich, der sich auf Funktionen erstreckt: +// Funktionen haben ihren eigenen Geltungsbereich, andere Blöcke nicht. +if(true) { + var i = 5; +} +i; // = 5 - nicht undefined, wie man es von einer Sprache erwarten würde, die + // ihren Geltungsbereich nach Blöcken richtet + +// Daraus ergibt sich ein bestimmtes Muster für sofort-ausführbare, anonyme +// Funktionen, die es vermeiden, dass der globale Geltungsbereich von Variablen +// 'verschmutzt' wird. +(function(){ + var temporary = 5; + // Auf eine Variable im globalen Geltungsbereich kann zugegriffen werden, + // sofern sie im globalen Objekt definiert ist (in einem Webbrowser ist + // dies immer das 'window'-Objekt, in anderen Umgebungen, bspw. Node.js, + // kann das anders aussehen). + window.permanent = 10; +})(); +temporary; // wirft einen ReferenceError +permanent; // = 10 + +// Eines der mächtigsten Charakteristika von JavaScript sind Closures. Wird +// eine Funktion innerhalb einer anderen Funktion definiert, dann hat die +// innere Funktion Zugriff auf alle Variablen der äußeren Funktion, sogar dann, +// wenn die äußere Funktion beendet wurde. +function sayHelloInFiveSeconds(name){ + var prompt = "Hello, " + name + "!"; + function inner(){ + alert(prompt); + } + setTimeout(inner, 5000); + // setTimeout wird asynchron ausgeführt. Also wird sayHelloInFiveSeconds + // sofort verlassen und setTimeout wird die innere Funktion 'im nachhinein' + // aufrufen. Dennoch: Weil sayHelloInFiveSeconds eine Hülle um die innere + // Funktion bildet, hat die innere Funktion immer noch Zugriff auf die + // Variable prompt. +} +sayHelloInFiveSeconds("Adam"); // wird nach 5 Sekunden ein Popup mit der + // Nachricht "Hello, Adam!" öffnen. + +/////////////////////////////////// +// 5. Mehr über Objekte, Konstruktoren und Prototypen + +// Objekte können Funktionen enthalten. +var myObj = { + myFunc: function(){ + return "Hello world!"; + } +}; +myObj.myFunc(); // = "Hello world!" + +// Wenn Funktionen aufgerufen werden, die zu einem Objekt gehören, können sie +// auf das eigene Objekt mit dem Schlüsselwort 'this' zugreifen. +myObj = { + myString: "Hello world!", + myFunc: function(){ + return this.myString; + } +}; +myObj.myFunc(); // = "Hello world!" + +// Worauf 'this' gesetzt wird, ist davon abhängig, wie die Funktion aufgerufen +// wird, nicht wo sie definiert wurde. Unsere Funktion wird daher nicht +// funktionieren, sofern sie außerhalb des Kontextes des Objekts aufgerufen +// wird. +var myFunc = myObj.myFunc; +myFunc(); // = undefined + +// Umgekehrt ist es möglich eine Funktion einem Objekt zuzuweisen und dadurch +// Zugriff auf den this-Kontext zu erhalten, sogar dann, wenn die Funktion dem +// Objekt nach dessen Definition zugewiesen wird. +var myOtherFunc = function(){ + return this.myString.toUpperCase(); +} +myObj.myOtherFunc = myOtherFunc; +myObj.myOtherFunc(); // = "HELLO WORLD!" + +// Mit den Methoden 'call' und 'apply' kann der Kontext eines Funktionsaufrufs +// verändert werden + +var anotherFunc = function(s){ + return this.myString + s; +} +anotherFunc.call(myObj, " And Hello Moon!"); // = "Hello World! And Hello Moon!" + +// 'apply' funktioniert beiahe identisch, erwartet die übergebenen Argumente +// aber in einem Array + +anotherFunc.apply(myObj, [" And Hello Sun!"]); // = "Hello World! And Hello Sun!" + +// Das ist hilfreich wenn man einer Funktion eine beliebige Zahl Argumente +// übergeben kann + +Math.min(42, 6, 27); // = 6 +Math.min([42, 6, 27]); // = NaN (uh-oh!) +Math.min.apply(Math, [42, 6, 27]); // = 6 + +// 'call' und 'apply' beeinflussen aber nur den spezifischen Aufruf. +// Um den Kontext einer Funktion dauerhaft zu ändern wird 'bind' benutzt. + +var boundFunc = anotherFunc.bind(myObj); +boundFunc(" And Hello Saturn!"); // = "Hello World! And Hello Saturn!" + +// Mit 'bind' lassen sich Funktionen auch teilweise anwenden / "curryen". +var product = function(a, b){ return a * b; } +var doubler = product.bind(this, 2); +doubler(8); // = 16 + +// Wenn eine Funktion mit dem Schlüsselwort 'new' aufgerufen wird, dann wird +// ein neues Objekt erzeugt. Funktionen, die darauf ausgelegt sind in dieser +// Art aufgerufen zu werden, werden Konstruktoren genannt. +var MyConstructor = function(){ + this.myNumber = 5; +} +myNewObj = new MyConstructor(); // = {myNumber: 5} +myNewObj.myNumber; // = 5 + +// Jedes JavaScript-Objekt hat einen Prototyp. Wenn man versucht auf eine +// Eigenschaft des Objekts zuzugreifen, das nicht im Objekt selbst existiert, +// schaut der Interpreter in dessen Prototyp nach. + +// Einige JavaScript-Implementierungen erlauben den direkten Zugriff auf den +// Prototyp eines Objekts durch die magische Eigenschaft __proto__. Obwohl das +// nützlich ist, um Prototypen im Allgemeinen zu erklären, ist das nicht Teil +// des Standards; zum Standard-Weg der Nutzung von Prototypen kommen wir +// später. +var myObj = { + myString: "Hello world!", +}; +var myPrototype = { + meaningOfLife: 42, + myFunc: function(){ + return this.myString.toLowerCase() + } +}; +myObj.__proto__ = myPrototype; +myObj.meaningOfLife; // = 42 + +// Das funktioniert auch bei Funktionen. +myObj.myFunc(); // = "hello world!" + +// Sollte die Eigenschaft nicht im Prototypen des Objekts enthalten sein, dann +// wird im Prototypen des Prototypen nachgesehen und so weiter. +myPrototype.__proto__ = { + myBoolean: true +}; +myObj.myBoolean; // = true + +// Dafür wird nichts hin und her kopiert; jedes Objekt speichert eine Referenz +// auf seinen Prototypen. Das heißt wenn der Prototyp geändert wird, dann +// werden die Änderungen überall sichtbar. +myPrototype.meaningOfLife = 43; +myObj.meaningOfLife; // = 43 + +// Es wurde bereits erwähnt, dass __proto__ nicht zum Standard gehört und es +// gibt ebenso keinen Standard-Weg, um den Prototyp eines existierenden Objekts +// zu ändern. Es gibt dennoch zwei Wege, wie man ein neues Objekt mit einem +// gegebenen Prototypen erzeugt. + +// Der erste Weg ist die Methode Object.create, die eine jüngere Ergänzung des +// JavaScript-Standards ist und daher noch nicht in allen Implementierungen +// verfügbar. +var myObj = Object.create(myPrototype); +myObj.meaningOfLife; // = 43 + +// Der zweite Weg, der immer funktioniert, hat mit den Konstruktoren zu tun. +// Konstruktoren haben eine Eigenschaft, die Prototyp heißt. Dabei handelt es +// sich *nicht* um den Prototypen der Konstruktor-Funktion; stattdessen handelt +// es sich um den Prototypen, der einem neuen Objekt mitgegeben wird, wenn es +// mit dem Konstruktor und dem Schlüsselwort 'new' erzeugt wird. +MyConstructor.prototype = { + getMyNumber: function(){ + return this.myNumber + } +}; +var myNewObj2 = new MyConstructor(); +myNewObj2.getMyNumber(); // = 5 + +// Alle primitiven Typen, also strings und numbers, haben auch Konstruktoren, +// die zu dem Typ äquivalente Wrapper-Objekte erzeugen. +var myNumber = 12; +var myNumberObj = new Number(12); +myNumber == myNumberObj; // = true + +// Genau genommen: Sie sind nicht exakt äquivalent. +typeof myNumber; // = 'number' +typeof myNumberObj; // = 'object' +myNumber === myNumberObj; // = false +if (0){ + // Dieser Teil wird nicht ausgeführt, weil 0 'falsy' ist. +} + +// Das Wrapper-Objekt und die regulären, eingebauten Typen, teilen sich einen +// Prototyp; so ist es möglich zum Beispiel einem String weitere Funktionen +// hinzuzufügen. +String.prototype.firstCharacter = function(){ + return this.charAt(0); +} +"abc".firstCharacter(); // = "a" + +// Diese Tatsache wird häufig bei einer Methode mit dem Namen 'polyfilling' +// verwendet: Dabei wird ein neues Feature von JavaScript in einer älteren +// Untermenge der Sprache integriert, so dass bestimmte Funktionen auch in +// älteren Umgebungen und Browsern verwendet werden können. + +// Ein Beispiel: Es wurde erwähnt, dass die Methode Object.create nicht in +// allen Umgebungen verfügbar ist - wir können sie dennoch verwenden, mit einem +// 'polyfill': +if (Object.create === undefined){ // überschreib nichts, was eventuell bereits + // existiert + Object.create = function(proto){ + // erstelle einen vorübergehenden Konstruktor mit dem richtigen + // Prototypen + var Constructor = function(){}; + Constructor.prototype = proto; + // verwende es dann, um ein neues Objekt mit einem passenden + // Prototypen zurückzugeben + return new Constructor(); + } +} +``` + +## Zur weiteren Lektüre (englisch) + +Das [Mozilla Developer Network](https://developer.mozilla.org/en-US/docs/Web/JavaScript) bietet eine ausgezeichnete Dokumentation für die Verwendung von JavaScript im Browser. Es ist außerdem ein Wiki und ermöglicht es damit anderen zu helfen, wenn man selbst ein wenig Wissen angesammelt hat. + +MDN's [A re-introduction to JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) führt sehr viele der hier vorgestellten Konzepte im Detail aus. + +Dieses Tutorial hat nur die Sprache JavaScript vorgestellt; um mehr über den Einsatz in Websites zu lernen, ist es ein guter Start etwas über das [Document Object Model](https://developer.mozilla.org/en-US/docs/Using_the_W3C_DOM_Level_1_Core) zu lernen. + +[JavaScript Garden](http://bonsaiden.github.io/JavaScript-Garden/) ist eine tiefgehende Einführung in die kontra-intuitiven Parts der Sprache. + +[JavaScript: The Definitive Guide](http://www.amazon.com/gp/product/0596805527/) ist ein Klassiker unter den Referenzen. + +Zusätzlich zu direkten Beiträgen zu diesem Artikel ist der Inhalt in Anlehnung an Louie Dinh's Python-Tutorial auf dieser Seite und das [JS Tutorial](https://developer.mozilla.org/en-US/docs/Web/JavaScript/A_re-introduction_to_JavaScript) des Mozilla Developer Network entstanden. diff --git a/de-de/make-de.html.markdown b/de-de/make-de.html.markdown index 1bae332c..3674f2f5 100644 --- a/de-de/make-de.html.markdown +++ b/de-de/make-de.html.markdown @@ -1,263 +1,263 @@ ---- -category: tool -tool: make -contributors: - - ["Robert Steed", "https://github.com/robochat"] - - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] -translators: - - ["Martin Schimandl", "https://github.com/Git-Jiro"] -filename: Makefile-de -lang: de-de ---- - -Eine Makefile definiert einen Graphen von Regeln um ein Ziel (oder Ziele) -zu erzeugen. Es dient dazu, die geringste Menge an Arbeit zu verrichten um -ein Ziel in Einklang mit dem Quellcode zu bringen. Make wurde berühmterweise -von Stuart Feldman 1976 übers Wochenende geschrieben. Make ist noch immer -sehr verbreitet (vorallem im Unix Umfeld) obwohl es bereits sehr viel -Konkurrenz und Kritik zu Make gibt. - -Es gibt eine Vielzahl an Varianten von Make, dieser Artikel beschäftigt sich -mit der Version GNU Make. Diese Version ist Standard auf Linux. - -```make - -# Kommentare können so geschrieben werden. - -# Dateien sollten Makefile heißen, denn dann können sie als `make ` -# aufgerufen werden. Ansonsten muss `make -f "dateiname" ` verwendet -# werden. - -# Warnung - Es sollten nur TABULATOREN zur Einrückung im Makefile verwendet -# werden. Niemals Leerzeichen! - -#----------------------------------------------------------------------- -# Grundlagen -#----------------------------------------------------------------------- - -# Eine Regel - Diese Regel wird nur abgearbeitet wenn die Datei file0.txt -# nicht existiert. -file0.txt: - echo "foo" > file0.txt - # Selbst Kommentare in der 'Rezept' Sektion werden an die Shell - # weitergegeben. Versuche `make file0.txt` oder einfach `make` - # die erste Regel ist die Standard-Regel. - - -# Diese Regel wird nur abgearbeitet, wenn file0.txt aktueller als file1.txt ist. -file1.txt: file0.txt - cat file0.txt > file1.txt - # Verwende die selben Quoting-Regeln wie die Shell - @cat file0.txt >> file1.txt - # @ unterdrückt die Ausgabe des Befehls an stdout. - -@echo 'hello' - # - bedeutet, dass Make die Abarbeitung fortsetzt auch wenn Fehler - # passieren. - # Versuche `make file1.txt` auf der Kommandozeile. - -# Eine Regel kann mehrere Ziele und mehrere Voraussetzungen haben. -file2.txt file3.txt: file0.txt file1.txt - touch file2.txt - touch file3.txt - -# Make wird sich beschweren, wenn es mehrere Rezepte für die gleiche Regel gibt. -# Leere Rezepte zählen nicht und können dazu verwendet werden weitere -# Voraussetzungen hinzuzufügen. - -#----------------------------------------------------------------------- -# Phony-Ziele -#----------------------------------------------------------------------- - -# Ein Phony-Ziel ist ein Ziel, das keine Datei ist. -# Es wird nie aktuell sein, daher wird Make immer versuchen, es abzuarbeiten -all: maker process - -# Es ist erlaubt Dinge ausserhalb der Reihenfolge zu deklarieren. -maker: - touch ex0.txt ex1.txt - -# Um das Fehlschlagen von Phony-Regeln zu vermeiden wenn eine echte Datei den -# selben namen wie ein Phony-Ziel hat: -.PHONY: all maker process -# Das ist ein spezielles Ziel. Es gibt noch ein paar mehr davon. - -# Eine Regel mit einem Phony-Ziel als Voraussetzung wird immer abgearbeitet -ex0.txt ex1.txt: maker - -# Häufige Phony-Ziele sind: all make clean install ... - -#----------------------------------------------------------------------- -# Automatische Variablen & Wildcards -#----------------------------------------------------------------------- - -process: file*.txt # Eine Wildcard um Dateinamen zu vergleichen - @echo $^ # $^ ist eine Variable die eine Liste aller - # Voraussetzungen enthält. - @echo $@ # Namen des Ziels ausgeben. - #(Bei mehreren Ziel-Regeln enthält $@ den Verursacher der Abarbeitung - #der Regel.) - @echo $< # Die erste Voraussetzung aus der Liste - @echo $? # Nur die Voraussetzungen, die nicht aktuell sind. - @echo $+ # Alle Voraussetzungen inklusive Duplikate (nicht wie Üblich) - #@echo $| # Alle 'order only' Voraussetzungen - -# Selbst wenn wir die Voraussetzungen der Regel aufteilen, $^ wird sie finden. -process: ex1.txt file0.txt -# ex1.txt wird gefunden werden, aber file0.txt wird dedupliziert. - -#----------------------------------------------------------------------- -# Muster -#----------------------------------------------------------------------- - -# Mit Mustern kann man make beibringen wie Dateien in andere Dateien -# umgewandelt werden. - -%.png: %.svg - inkscape --export-png $^ - -# Muster-Vergleichs-Regeln werden nur abgearbeitet, wenn make entscheidet das -# Ziel zu erzeugen - -# Verzeichnis-Pfade werden normalerweise bei Muster-Vergleichs-Regeln ignoriert. -# Aber make wird versuchen die am besten passende Regel zu verwenden. -small/%.png: %.svg - inkscape --export-png --export-dpi 30 $^ - -# Make wird die letzte Version einer Muster-Vergleichs-Regel verwenden, die es -# findet. -%.png: %.svg - @echo this rule is chosen - -# Allerdings wird make die erste Muster-Vergleicher-Regel verwenden, die das -# Ziel erzeugen kann. -%.png: %.ps - @echo this rule is not chosen if *.svg and *.ps are both present - -# Make hat bereits ein paar eingebaute Muster-Vergleichs-Regelen. Zum Beispiel -# weiß Make wie man aus *.c Dateien *.o Dateien erzeugt. - -# Ältere Versionen von Make verwenden möglicherweise Suffix-Regeln anstatt -# Muster-Vergleichs-Regeln. -.png.ps: - @echo this rule is similar to a pattern rule. - -# Aktivieren der Suffix-Regel -.SUFFIXES: .png - -#----------------------------------------------------------------------- -# Variablen -#----------------------------------------------------------------------- -# auch Makros genannt. - -# Variablen sind im Grunde genommen Zeichenketten-Typen. - -name = Ted -name2="Sarah" - -echo: - @echo $(name) - @echo ${name2} - @echo $name # Das funktioniert nicht, wird als $(n)ame behandelt. - @echo $(name3) # Unbekannte Variablen werden als leere Zeichenketten behandelt. - -# Es git 4 Stellen um Variablen zu setzen. -# In Reihenfolge der Priorität von höchster zu niedrigster: -# 1: Befehls-Zeilen Argumente -# 2: Makefile -# 3: Shell Umbebungs-Variablen - Make importiert diese automatisch. -# 3: MAke hat einige vordefinierte Variablen. - -name4 ?= Jean -# Setze die Variable nur wenn es eine gleichnamige Umgebungs-Variable noch -# nicht gibt. - -override name5 = David -# Verhindert, dass Kommando-Zeilen Argumente diese Variable ändern können. - -name4 +=grey -# Werte an eine Variable anhängen (inkludiert Leerzeichen). - -# Muster-Spezifische Variablen Werte (GNU Erweiterung). -echo: name2 = Sara # Wahr innerhalb der passenden Regel und auch innerhalb - # rekursiver Voraussetzungen (ausser wenn es den Graphen zerstören - # kann, wenn es zu kompilizert wird!) - -# Ein paar Variablen, die von Make automatisch definiert werden. -echo_inbuilt: - echo $(CC) - echo ${CXX} - echo $(FC) - echo ${CFLAGS} - echo $(CPPFLAGS) - echo ${CXXFLAGS} - echo $(LDFLAGS) - echo ${LDLIBS} - -#----------------------------------------------------------------------- -# Variablen 2 -#----------------------------------------------------------------------- - -# Der erste Typ von Variablen wird bei jeder Verwendung ausgewertet. -# Das kann aufwendig sein, daher exisitert ein zweiter Typ von Variablen. -# Diese werden nur einmal ausgewertet. (Das ist eine GNU make Erweiterung) - -var := hello -var2 ::= $(var) hello -#:= und ::= sind äquivalent. - -# Diese Variablen werden prozedural ausgwertet (in der Reihenfolge in der sie -# auftauchen), die stehen daher im wiederspruch zum Rest der Sprache! - -# Das funktioniert nicht -var3 ::= $(var4) and good luck -var4 ::= good night - -#----------------------------------------------------------------------- -# Funktionen -#----------------------------------------------------------------------- - -# Make verfügt über eine Vielzahl von Funktionen. - -sourcefiles = $(wildcard *.c */*.c) -objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) - -# Das Format ist $(func arg0,arg1,arg2...) - -# Ein paar Beispiele -ls: * src/* - @echo $(filter %.txt, $^) - @echo $(notdir $^) - @echo $(join $(dir $^),$(notdir $^)) - -#----------------------------------------------------------------------- -# Direktiven -#----------------------------------------------------------------------- - -# Inkludiere andere Makefile, sehr praktisch für platformspezifischen Code -include foo.mk - -sport = tennis -# Konditionale kompiliereung -report: -ifeq ($(sport),tennis) - @echo 'game, set, match' -else - @echo "They think it's all over; it is now" -endif - -# Es gibt auch ifneq, ifdef, ifndef - -foo = true - -ifdef $(foo) -bar = 'hello' -endif -``` - - -### Mehr Resourcen - -+ [gnu make documentation](https://www.gnu.org/software/make/manual/) -+ [software carpentry tutorial](http://swcarpentry.github.io/make-novice/) -+ learn C the hard way [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) - +--- +category: tool +tool: make +contributors: + - ["Robert Steed", "https://github.com/robochat"] + - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] +translators: + - ["Martin Schimandl", "https://github.com/Git-Jiro"] +filename: Makefile-de +lang: de-de +--- + +Eine Makefile definiert einen Graphen von Regeln um ein Ziel (oder Ziele) +zu erzeugen. Es dient dazu, die geringste Menge an Arbeit zu verrichten um +ein Ziel in Einklang mit dem Quellcode zu bringen. Make wurde berühmterweise +von Stuart Feldman 1976 übers Wochenende geschrieben. Make ist noch immer +sehr verbreitet (vorallem im Unix Umfeld) obwohl es bereits sehr viel +Konkurrenz und Kritik zu Make gibt. + +Es gibt eine Vielzahl an Varianten von Make, dieser Artikel beschäftigt sich +mit der Version GNU Make. Diese Version ist Standard auf Linux. + +```make + +# Kommentare können so geschrieben werden. + +# Dateien sollten Makefile heißen, denn dann können sie als `make ` +# aufgerufen werden. Ansonsten muss `make -f "dateiname" ` verwendet +# werden. + +# Warnung - Es sollten nur TABULATOREN zur Einrückung im Makefile verwendet +# werden. Niemals Leerzeichen! + +#----------------------------------------------------------------------- +# Grundlagen +#----------------------------------------------------------------------- + +# Eine Regel - Diese Regel wird nur abgearbeitet wenn die Datei file0.txt +# nicht existiert. +file0.txt: + echo "foo" > file0.txt + # Selbst Kommentare in der 'Rezept' Sektion werden an die Shell + # weitergegeben. Versuche `make file0.txt` oder einfach `make` + # die erste Regel ist die Standard-Regel. + + +# Diese Regel wird nur abgearbeitet, wenn file0.txt aktueller als file1.txt ist. +file1.txt: file0.txt + cat file0.txt > file1.txt + # Verwende die selben Quoting-Regeln wie die Shell + @cat file0.txt >> file1.txt + # @ unterdrückt die Ausgabe des Befehls an stdout. + -@echo 'hello' + # - bedeutet, dass Make die Abarbeitung fortsetzt auch wenn Fehler + # passieren. + # Versuche `make file1.txt` auf der Kommandozeile. + +# Eine Regel kann mehrere Ziele und mehrere Voraussetzungen haben. +file2.txt file3.txt: file0.txt file1.txt + touch file2.txt + touch file3.txt + +# Make wird sich beschweren, wenn es mehrere Rezepte für die gleiche Regel gibt. +# Leere Rezepte zählen nicht und können dazu verwendet werden weitere +# Voraussetzungen hinzuzufügen. + +#----------------------------------------------------------------------- +# Phony-Ziele +#----------------------------------------------------------------------- + +# Ein Phony-Ziel ist ein Ziel, das keine Datei ist. +# Es wird nie aktuell sein, daher wird Make immer versuchen, es abzuarbeiten +all: maker process + +# Es ist erlaubt Dinge ausserhalb der Reihenfolge zu deklarieren. +maker: + touch ex0.txt ex1.txt + +# Um das Fehlschlagen von Phony-Regeln zu vermeiden wenn eine echte Datei den +# selben namen wie ein Phony-Ziel hat: +.PHONY: all maker process +# Das ist ein spezielles Ziel. Es gibt noch ein paar mehr davon. + +# Eine Regel mit einem Phony-Ziel als Voraussetzung wird immer abgearbeitet +ex0.txt ex1.txt: maker + +# Häufige Phony-Ziele sind: all make clean install ... + +#----------------------------------------------------------------------- +# Automatische Variablen & Wildcards +#----------------------------------------------------------------------- + +process: file*.txt # Eine Wildcard um Dateinamen zu vergleichen + @echo $^ # $^ ist eine Variable die eine Liste aller + # Voraussetzungen enthält. + @echo $@ # Namen des Ziels ausgeben. + #(Bei mehreren Ziel-Regeln enthält $@ den Verursacher der Abarbeitung + #der Regel.) + @echo $< # Die erste Voraussetzung aus der Liste + @echo $? # Nur die Voraussetzungen, die nicht aktuell sind. + @echo $+ # Alle Voraussetzungen inklusive Duplikate (nicht wie Üblich) + #@echo $| # Alle 'order only' Voraussetzungen + +# Selbst wenn wir die Voraussetzungen der Regel aufteilen, $^ wird sie finden. +process: ex1.txt file0.txt +# ex1.txt wird gefunden werden, aber file0.txt wird dedupliziert. + +#----------------------------------------------------------------------- +# Muster +#----------------------------------------------------------------------- + +# Mit Mustern kann man make beibringen wie Dateien in andere Dateien +# umgewandelt werden. + +%.png: %.svg + inkscape --export-png $^ + +# Muster-Vergleichs-Regeln werden nur abgearbeitet, wenn make entscheidet das +# Ziel zu erzeugen + +# Verzeichnis-Pfade werden normalerweise bei Muster-Vergleichs-Regeln ignoriert. +# Aber make wird versuchen die am besten passende Regel zu verwenden. +small/%.png: %.svg + inkscape --export-png --export-dpi 30 $^ + +# Make wird die letzte Version einer Muster-Vergleichs-Regel verwenden, die es +# findet. +%.png: %.svg + @echo this rule is chosen + +# Allerdings wird make die erste Muster-Vergleicher-Regel verwenden, die das +# Ziel erzeugen kann. +%.png: %.ps + @echo this rule is not chosen if *.svg and *.ps are both present + +# Make hat bereits ein paar eingebaute Muster-Vergleichs-Regelen. Zum Beispiel +# weiß Make wie man aus *.c Dateien *.o Dateien erzeugt. + +# Ältere Versionen von Make verwenden möglicherweise Suffix-Regeln anstatt +# Muster-Vergleichs-Regeln. +.png.ps: + @echo this rule is similar to a pattern rule. + +# Aktivieren der Suffix-Regel +.SUFFIXES: .png + +#----------------------------------------------------------------------- +# Variablen +#----------------------------------------------------------------------- +# auch Makros genannt. + +# Variablen sind im Grunde genommen Zeichenketten-Typen. + +name = Ted +name2="Sarah" + +echo: + @echo $(name) + @echo ${name2} + @echo $name # Das funktioniert nicht, wird als $(n)ame behandelt. + @echo $(name3) # Unbekannte Variablen werden als leere Zeichenketten behandelt. + +# Es git 4 Stellen um Variablen zu setzen. +# In Reihenfolge der Priorität von höchster zu niedrigster: +# 1: Befehls-Zeilen Argumente +# 2: Makefile +# 3: Shell Umbebungs-Variablen - Make importiert diese automatisch. +# 3: MAke hat einige vordefinierte Variablen. + +name4 ?= Jean +# Setze die Variable nur wenn es eine gleichnamige Umgebungs-Variable noch +# nicht gibt. + +override name5 = David +# Verhindert, dass Kommando-Zeilen Argumente diese Variable ändern können. + +name4 +=grey +# Werte an eine Variable anhängen (inkludiert Leerzeichen). + +# Muster-Spezifische Variablen Werte (GNU Erweiterung). +echo: name2 = Sara # Wahr innerhalb der passenden Regel und auch innerhalb + # rekursiver Voraussetzungen (ausser wenn es den Graphen zerstören + # kann, wenn es zu kompilizert wird!) + +# Ein paar Variablen, die von Make automatisch definiert werden. +echo_inbuilt: + echo $(CC) + echo ${CXX} + echo $(FC) + echo ${CFLAGS} + echo $(CPPFLAGS) + echo ${CXXFLAGS} + echo $(LDFLAGS) + echo ${LDLIBS} + +#----------------------------------------------------------------------- +# Variablen 2 +#----------------------------------------------------------------------- + +# Der erste Typ von Variablen wird bei jeder Verwendung ausgewertet. +# Das kann aufwendig sein, daher exisitert ein zweiter Typ von Variablen. +# Diese werden nur einmal ausgewertet. (Das ist eine GNU make Erweiterung) + +var := hello +var2 ::= $(var) hello +#:= und ::= sind äquivalent. + +# Diese Variablen werden prozedural ausgwertet (in der Reihenfolge in der sie +# auftauchen), die stehen daher im wiederspruch zum Rest der Sprache! + +# Das funktioniert nicht +var3 ::= $(var4) and good luck +var4 ::= good night + +#----------------------------------------------------------------------- +# Funktionen +#----------------------------------------------------------------------- + +# Make verfügt über eine Vielzahl von Funktionen. + +sourcefiles = $(wildcard *.c */*.c) +objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) + +# Das Format ist $(func arg0,arg1,arg2...) + +# Ein paar Beispiele +ls: * src/* + @echo $(filter %.txt, $^) + @echo $(notdir $^) + @echo $(join $(dir $^),$(notdir $^)) + +#----------------------------------------------------------------------- +# Direktiven +#----------------------------------------------------------------------- + +# Inkludiere andere Makefile, sehr praktisch für platformspezifischen Code +include foo.mk + +sport = tennis +# Konditionale kompiliereung +report: +ifeq ($(sport),tennis) + @echo 'game, set, match' +else + @echo "They think it's all over; it is now" +endif + +# Es gibt auch ifneq, ifdef, ifndef + +foo = true + +ifdef $(foo) +bar = 'hello' +endif +``` + + +### Mehr Resourcen + ++ [gnu make documentation](https://www.gnu.org/software/make/manual/) ++ [software carpentry tutorial](http://swcarpentry.github.io/make-novice/) ++ learn C the hard way [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) + diff --git a/docker.html.markdown b/docker.html.markdown index 17f803f4..ec6abe7e 100644 --- a/docker.html.markdown +++ b/docker.html.markdown @@ -1,281 +1,281 @@ ---- -category: tool -tool: docker -filename: docker.bat -contributors: - - ["Ruslan López", "http://javapro.org/"] - - ["Michael Chen", "https://github.com/ML-Chen"] - - ["Akshita Dixit", "https://github.com/akshitadixit"] - - ["Marcel Ribeiro-Dantas", "https://github.com/mribeirodantas"] ---- - -Docker is a tool that helps you build, test, ship and run applications -seamlessly across various machines. It replicates the environment our software -needs on any machine. You can get Docker for your machine from -https://docs.docker.com/get-docker/ - -It has grown in popularity over the last decade due to being lightweight and -fast as compared to virtual-machines that are bulky and slow. Unlike VMs, docker -does not need a full blown OS of its own to be loaded to start and does not -compete for resources other than what the application it is running will use. -VMs on the other hand are pretty resource intensive on our processors, disks and -memory hence running multiple VMs for various applications becomes a challenge -in a limited capacity architecture. - -
-┌────────────────────────┐ ┌───────────────────────┐
-│      ┌───────────┐     │ │      ┌───────────┐    │
-│      │   App     │     │ │      │   App     │    │
-│      └───────────┘     │ │      └───────────┘    │
-│  ┌────────┐ ┌────────┐ │ │  ┌────────┐ ┌───────┐ │
-│  │  Libs  │ │  Deps  │ │ │  │  Libs  │ │  Deps │ │
-│  └────────┘ └────────┘ │ │  └────────┘ └───────┘ │
-│  ┌───────────────────┐ │ │  ┌──────────────────┐ │
-│  │      Guest OS     │ │ │  │     Guest OS     │ │
-│  └───────────────────┘ │ │  └──────────────────┘ │
-│           VM1          │ │           VM2         │
-└────────────────────────┘ └───────────────────────┘
-┌──────────────────────────────────────────────────┐
-│                     Hypervisor                   │
-└──────────────────────────────────────────────────┘
-┌──────────────────────────────────────────────────┐
-│                      Host OS                     │
-└──────────────────────────────────────────────────┘
-┌──────────────────────────────────────────────────┐
-│             Hardware Infrastructure              │
-└──────────────────────────────────────────────────┘
-              (VM based architecture)
-
-┌────────────────────────┐ ┌───────────────────────┐
-│      ┌───────────┐     │ │      ┌───────────┐    │
-│      │   App     │     │ │      │   App     │    │
-│      └───────────┘     │ │      └───────────┘    │
-│  ┌────────┐ ┌────────┐ │ │  ┌────────┐ ┌───────┐ │
-│  │  Libs  │ │  Deps  │ │ │  │  Libs  │ │  Deps │ │
-│  └────────┘ └────────┘ │ │  └────────┘ └───────┘ │
-│        Container1      │ │       Container2      │
-└────────────────────────┘ └───────────────────────┘
-┌──────────────────────────────────────────────────┐
-│                       Docker                     │
-└──────────────────────────────────────────────────┘
-┌──────────────────────────────────────────────────┐
-│                        OS                        │
-└──────────────────────────────────────────────────┘
-┌──────────────────────────────────────────────────┐
-│             Hardware Infrastructure              │
-└──────────────────────────────────────────────────┘
-            (Docker based architecture)
-
-
- -Couple of terms we will encounter frequently are Docker Images and Docker -Containers. Images are packages or templates of containers all stored in a -container registry such as [Docker Hub](https://hub.docker.com/). Containers -are standalone, executable instances of these images which include code, -runtime, system tools, system libraries and settings - everything required to -get the software up and running. Coming to Docker, it follows a client-server -architecture wherein the CLI client communicates with the server component, -which here is, the Docker Engine using RESTful API to issue commands. - -## The Docker CLI -```bash -# after installing Docker from https://docs.docker.com/get-docker/ -# To list available commands, either run `docker` with no parameters or execute -# `docker help` -$ docker - ->>> docker [OPTIONS] COMMAND [ARG...] - docker [ --help | -v | --version ] - - A self-sufficient runtime for containers. - - Options: - --config string Location of client config files (default "/root/.docker") - -c, --context string Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with "docker context use") - -D, --debug Enable debug mode - --help Print usage - -H, --host value Daemon socket(s) to connect to (default []) - -l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") - --tls Use TLS; implied by --tlsverify - --tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem") - --tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem") - --tlskey string Path to TLS key file (default "/root/.docker/key.pem") - --tlsverify Use TLS and verify the remote - -v, --version Print version information and quit - - Commands: - attach Attach to a running container - # […] - -$ docker run hello-world -# `docker run ` is used to run a container, it will pull the -# images from Docker Hub if they don't already exist in your system. Here the -# docker client connects to the daemon which in turn pulls the "hello-world" -# image from the Docker Hub. The daemon then builds a new container from the -# image which runs the executable that produces the output streamed back to the -# client that we see on our terminals. - -$ docker run -d ubuntu sleep 60s -# The -d (or --detach) flag is when we want to run a container in the background -# and return back to the terminal. Here we detach an ubuntu container from the -# terminal, the output should be the id and the command exits. If we check -# running containers, we should still see ours there: -# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -# 133261b4894a ubuntu "sleep 60s" 3 seconds ago Up 2 seconds vigorous_gould - -$ docker run -p 3000:8000 -# The -p (or --publish) flag is used to expose port 8000 inside the container to -# port 3000 outside the container. This is because the app inside the container -# runs in isolation, hence the port 8000 where the app runs is private to the -# container. - -$ docker run -i -# or -$ docker run -it -# Docker runs our containers in a non-interactive mode i.e. they do not accept -# inputs or work dynamically while running. The -i flag keeps input open to the -# container, and the -t flag creates a pseudo-terminal that the shell can attach -# to (can be combined as -it) - -$ docker ps -a -# The `docker ps` command only shows running containers by default. To see all -# containers, use the -a (or --all) flag -# Running the above command should output something similar in the terminal: -# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -# 82f84bf6912b hello-world "/hello" 9 minutes ago Exited (0) 9 minutes ago eloquent_sammet - - -$ docker stop hello-world -# or -$ docker start hello-world -# The stop command simply stops one or more containers, and the start command -# starts the container(s) up again! `docker start -a ubuntu` will attach our -# detached container back to the terminal i.e. runs in the foreground - -$ docker create alpine -# `docker create` creates a new container for us with the image specified (here, -# alpine), the container does not auto-start unlike `docker run`. This command -# is used to set up a container configuration and then `docker start` to shoot -# it up when required. Note that the status is "Created": -# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -# 4c71c727c73d alpine "/bin/sh" 29 seconds ago Created naughty_ritchie - -$ docker rm 82f84 -# Removes one or more containers using their container ID. -# P.S.: we can use only the first few characters of the entire ID to identify -# containers - -$ docker images -# Displays all images and their information, created here means the latest image -# tag updated on Docker Hub: -# REPOSITORY TAG IMAGE ID CREATED SIZE -# ubuntu latest a8780b506fa4 9 days ago 77.8MB -# alpine latest 9c6f07244728 3 months ago 5.54MB -# hello-world latest feb5d9fea6a5 13 months ago 13.3kB - -$ docker rmi -# Removes one or more images from your system which do not have their instances -# (or containers as we know them) running. If the image has an attached -# container, either delete the container first or use the -f (or --force) flag -# to forcefully delete both the container and image. - -$ docker pull busybox -# The pull command downloads the specified image on our system from Docker Hub. - -$ docker exec -it 7b272 bash -# This command is used to run a command in the running container's default -# directory. Here 7b272 was our ubuntu container and the above command would -# help us interact with the container by opening a bash session. - -$ docker logs -# Displays the information logged by the specified container -# root@7b27222e4bb7:/# whoami -# root -# root@7b27222e4bb7:/# pwd -# / -# root@7b27222e4bb7:/# ls -# bin boot dev etc home lib lib32 lib64 libx3 srv sys tmp usr var -# root@7b27222e4bb7:/# exit -# exit - -# More commands can be found at https://docs.docker.com/engine/reference/commandline/docker/ -``` -## The Dockerfile -The Dockerfile is a blueprint of a Docker image. We can mention the artifacts -from our application along with their configurations into this file in the -specific syntax to let anyone create a Docker image of our application. - -### A few things to keep in mind: -* It is always strictly named `Dockerfile` without any extensions -* We have to build our custom image on top of some already available Docker base -image. (there is an empty image called `scratch` which literally lets you build -an image from scratch) -* All capitalised commands are part of the syntax, they are not case-sensitive -but used like a convention -* Below is a sample Dockerfile but you can read in depth from the [official docs](https://docs.docker.com/engine/reference/builder/). - -```Dockerfile -FROM -# define base image - -ENV USERNAME='admin'\ - PWD='****' -# optionally define environmental variables - -RUN apt-get update -# run linux commands inside container env, does not affect host env -# This executes during the time of image creation - -COPY -# executes on the host, copies files from src (usually on the host) to target -# on the container - -ENTRYPOINT ["some-script.sh"] -# executes an entire script as an entrypoint - -CMD [,...] -# always part of dockerfile, introduces entry point linux command e.g. -# `CMD node server.js` -# This executes after image creation only when the container from the image -# is running. -``` -### Build your images -Use the `docker build` command after wrapping your application into a Docker -image to run ( or build) it. - -```bash - -$ docker build -# used to build an image from the specified Dockerfile -# instead of path we could also specify a URL -# -t tag is optional and used to name and tag your images for e.g. -# `$ docker build -t my-image:0.1 ./home/app` -# rebuild images everytime you make changes in the dockerfile -``` - -## Push your image to DockerHub -If you want your application's Docker image to be made publicly available for -any Docker user, you might wanna push it to the [Docker Hub](https://hub.docker.com/) which is a -registry of Docker images. Make sure you have an account with a username and -password on Docker Hub. - -When pushing an image to Docker Hub, we must specify our Docker Hub username -as part of the source image name. We need to create the target image with the -tag name of username/image-name much like GitHub repositories. - -```bash -$ docker login -# to login to Docker Hub using your username and password - -$ docker tag [:] [:] -# this tags a local src-image to a public target-image -# e.g. `docker tag my-sample-app:1.0.0 akshitadixit/my-sample-app` -# if tags are not specified, they're defaulted to `latest` - -$ docker push [:] -# uploads our image to Docker Hub -# e.g. `docker push akshitadixit/my-sample-app` -# this image will be accessible under your profile's repositories as -# `https://hub.docker.com/r/username/image-name` - -``` +--- +category: tool +tool: docker +filename: docker.bat +contributors: + - ["Ruslan López", "http://javapro.org/"] + - ["Michael Chen", "https://github.com/ML-Chen"] + - ["Akshita Dixit", "https://github.com/akshitadixit"] + - ["Marcel Ribeiro-Dantas", "https://github.com/mribeirodantas"] +--- + +Docker is a tool that helps you build, test, ship and run applications +seamlessly across various machines. It replicates the environment our software +needs on any machine. You can get Docker for your machine from +https://docs.docker.com/get-docker/ + +It has grown in popularity over the last decade due to being lightweight and +fast as compared to virtual-machines that are bulky and slow. Unlike VMs, docker +does not need a full blown OS of its own to be loaded to start and does not +compete for resources other than what the application it is running will use. +VMs on the other hand are pretty resource intensive on our processors, disks and +memory hence running multiple VMs for various applications becomes a challenge +in a limited capacity architecture. + +
+┌────────────────────────┐ ┌───────────────────────┐
+│      ┌───────────┐     │ │      ┌───────────┐    │
+│      │   App     │     │ │      │   App     │    │
+│      └───────────┘     │ │      └───────────┘    │
+│  ┌────────┐ ┌────────┐ │ │  ┌────────┐ ┌───────┐ │
+│  │  Libs  │ │  Deps  │ │ │  │  Libs  │ │  Deps │ │
+│  └────────┘ └────────┘ │ │  └────────┘ └───────┘ │
+│  ┌───────────────────┐ │ │  ┌──────────────────┐ │
+│  │      Guest OS     │ │ │  │     Guest OS     │ │
+│  └───────────────────┘ │ │  └──────────────────┘ │
+│           VM1          │ │           VM2         │
+└────────────────────────┘ └───────────────────────┘
+┌──────────────────────────────────────────────────┐
+│                     Hypervisor                   │
+└──────────────────────────────────────────────────┘
+┌──────────────────────────────────────────────────┐
+│                      Host OS                     │
+└──────────────────────────────────────────────────┘
+┌──────────────────────────────────────────────────┐
+│             Hardware Infrastructure              │
+└──────────────────────────────────────────────────┘
+              (VM based architecture)
+
+┌────────────────────────┐ ┌───────────────────────┐
+│      ┌───────────┐     │ │      ┌───────────┐    │
+│      │   App     │     │ │      │   App     │    │
+│      └───────────┘     │ │      └───────────┘    │
+│  ┌────────┐ ┌────────┐ │ │  ┌────────┐ ┌───────┐ │
+│  │  Libs  │ │  Deps  │ │ │  │  Libs  │ │  Deps │ │
+│  └────────┘ └────────┘ │ │  └────────┘ └───────┘ │
+│        Container1      │ │       Container2      │
+└────────────────────────┘ └───────────────────────┘
+┌──────────────────────────────────────────────────┐
+│                       Docker                     │
+└──────────────────────────────────────────────────┘
+┌──────────────────────────────────────────────────┐
+│                        OS                        │
+└──────────────────────────────────────────────────┘
+┌──────────────────────────────────────────────────┐
+│             Hardware Infrastructure              │
+└──────────────────────────────────────────────────┘
+            (Docker based architecture)
+
+
+ +Couple of terms we will encounter frequently are Docker Images and Docker +Containers. Images are packages or templates of containers all stored in a +container registry such as [Docker Hub](https://hub.docker.com/). Containers +are standalone, executable instances of these images which include code, +runtime, system tools, system libraries and settings - everything required to +get the software up and running. Coming to Docker, it follows a client-server +architecture wherein the CLI client communicates with the server component, +which here is, the Docker Engine using RESTful API to issue commands. + +## The Docker CLI +```bash +# after installing Docker from https://docs.docker.com/get-docker/ +# To list available commands, either run `docker` with no parameters or execute +# `docker help` +$ docker + +>>> docker [OPTIONS] COMMAND [ARG...] + docker [ --help | -v | --version ] + + A self-sufficient runtime for containers. + + Options: + --config string Location of client config files (default "/root/.docker") + -c, --context string Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default context set with "docker context use") + -D, --debug Enable debug mode + --help Print usage + -H, --host value Daemon socket(s) to connect to (default []) + -l, --log-level string Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info") + --tls Use TLS; implied by --tlsverify + --tlscacert string Trust certs signed only by this CA (default "/root/.docker/ca.pem") + --tlscert string Path to TLS certificate file (default "/root/.docker/cert.pem") + --tlskey string Path to TLS key file (default "/root/.docker/key.pem") + --tlsverify Use TLS and verify the remote + -v, --version Print version information and quit + + Commands: + attach Attach to a running container + # […] + +$ docker run hello-world +# `docker run ` is used to run a container, it will pull the +# images from Docker Hub if they don't already exist in your system. Here the +# docker client connects to the daemon which in turn pulls the "hello-world" +# image from the Docker Hub. The daemon then builds a new container from the +# image which runs the executable that produces the output streamed back to the +# client that we see on our terminals. + +$ docker run -d ubuntu sleep 60s +# The -d (or --detach) flag is when we want to run a container in the background +# and return back to the terminal. Here we detach an ubuntu container from the +# terminal, the output should be the id and the command exits. If we check +# running containers, we should still see ours there: +# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +# 133261b4894a ubuntu "sleep 60s" 3 seconds ago Up 2 seconds vigorous_gould + +$ docker run -p 3000:8000 +# The -p (or --publish) flag is used to expose port 8000 inside the container to +# port 3000 outside the container. This is because the app inside the container +# runs in isolation, hence the port 8000 where the app runs is private to the +# container. + +$ docker run -i +# or +$ docker run -it +# Docker runs our containers in a non-interactive mode i.e. they do not accept +# inputs or work dynamically while running. The -i flag keeps input open to the +# container, and the -t flag creates a pseudo-terminal that the shell can attach +# to (can be combined as -it) + +$ docker ps -a +# The `docker ps` command only shows running containers by default. To see all +# containers, use the -a (or --all) flag +# Running the above command should output something similar in the terminal: +# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +# 82f84bf6912b hello-world "/hello" 9 minutes ago Exited (0) 9 minutes ago eloquent_sammet + + +$ docker stop hello-world +# or +$ docker start hello-world +# The stop command simply stops one or more containers, and the start command +# starts the container(s) up again! `docker start -a ubuntu` will attach our +# detached container back to the terminal i.e. runs in the foreground + +$ docker create alpine +# `docker create` creates a new container for us with the image specified (here, +# alpine), the container does not auto-start unlike `docker run`. This command +# is used to set up a container configuration and then `docker start` to shoot +# it up when required. Note that the status is "Created": +# CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +# 4c71c727c73d alpine "/bin/sh" 29 seconds ago Created naughty_ritchie + +$ docker rm 82f84 +# Removes one or more containers using their container ID. +# P.S.: we can use only the first few characters of the entire ID to identify +# containers + +$ docker images +# Displays all images and their information, created here means the latest image +# tag updated on Docker Hub: +# REPOSITORY TAG IMAGE ID CREATED SIZE +# ubuntu latest a8780b506fa4 9 days ago 77.8MB +# alpine latest 9c6f07244728 3 months ago 5.54MB +# hello-world latest feb5d9fea6a5 13 months ago 13.3kB + +$ docker rmi +# Removes one or more images from your system which do not have their instances +# (or containers as we know them) running. If the image has an attached +# container, either delete the container first or use the -f (or --force) flag +# to forcefully delete both the container and image. + +$ docker pull busybox +# The pull command downloads the specified image on our system from Docker Hub. + +$ docker exec -it 7b272 bash +# This command is used to run a command in the running container's default +# directory. Here 7b272 was our ubuntu container and the above command would +# help us interact with the container by opening a bash session. + +$ docker logs +# Displays the information logged by the specified container +# root@7b27222e4bb7:/# whoami +# root +# root@7b27222e4bb7:/# pwd +# / +# root@7b27222e4bb7:/# ls +# bin boot dev etc home lib lib32 lib64 libx3 srv sys tmp usr var +# root@7b27222e4bb7:/# exit +# exit + +# More commands can be found at https://docs.docker.com/engine/reference/commandline/docker/ +``` +## The Dockerfile +The Dockerfile is a blueprint of a Docker image. We can mention the artifacts +from our application along with their configurations into this file in the +specific syntax to let anyone create a Docker image of our application. + +### A few things to keep in mind: +* It is always strictly named `Dockerfile` without any extensions +* We have to build our custom image on top of some already available Docker base +image. (there is an empty image called `scratch` which literally lets you build +an image from scratch) +* All capitalised commands are part of the syntax, they are not case-sensitive +but used like a convention +* Below is a sample Dockerfile but you can read in depth from the [official docs](https://docs.docker.com/engine/reference/builder/). + +```Dockerfile +FROM +# define base image + +ENV USERNAME='admin'\ + PWD='****' +# optionally define environmental variables + +RUN apt-get update +# run linux commands inside container env, does not affect host env +# This executes during the time of image creation + +COPY +# executes on the host, copies files from src (usually on the host) to target +# on the container + +ENTRYPOINT ["some-script.sh"] +# executes an entire script as an entrypoint + +CMD [,...] +# always part of dockerfile, introduces entry point linux command e.g. +# `CMD node server.js` +# This executes after image creation only when the container from the image +# is running. +``` +### Build your images +Use the `docker build` command after wrapping your application into a Docker +image to run ( or build) it. + +```bash + +$ docker build +# used to build an image from the specified Dockerfile +# instead of path we could also specify a URL +# -t tag is optional and used to name and tag your images for e.g. +# `$ docker build -t my-image:0.1 ./home/app` +# rebuild images everytime you make changes in the dockerfile +``` + +## Push your image to DockerHub +If you want your application's Docker image to be made publicly available for +any Docker user, you might wanna push it to the [Docker Hub](https://hub.docker.com/) which is a +registry of Docker images. Make sure you have an account with a username and +password on Docker Hub. + +When pushing an image to Docker Hub, we must specify our Docker Hub username +as part of the source image name. We need to create the target image with the +tag name of username/image-name much like GitHub repositories. + +```bash +$ docker login +# to login to Docker Hub using your username and password + +$ docker tag [:] [:] +# this tags a local src-image to a public target-image +# e.g. `docker tag my-sample-app:1.0.0 akshitadixit/my-sample-app` +# if tags are not specified, they're defaulted to `latest` + +$ docker push [:] +# uploads our image to Docker Hub +# e.g. `docker push akshitadixit/my-sample-app` +# this image will be accessible under your profile's repositories as +# `https://hub.docker.com/r/username/image-name` + +``` diff --git a/es-es/docker-es.html.markdown b/es-es/docker-es.html.markdown index 93e17f02..81e3cefe 100644 --- a/es-es/docker-es.html.markdown +++ b/es-es/docker-es.html.markdown @@ -1,167 +1,167 @@ ---- -language: docker -filename: docker-es.bat -contributors: - - ["Ruslan López", "http://javapro.org/"] - - ["Michael Chen", "https://github.com/ML-Chen"] -lang: es-es ---- - -```bat -:: descargar, instalar y ejecutar la imágen del hola mundo -docker run hello-world - -:: Si esta es la primera vez, deberíais de poder ver el mensaje -:: Unable to find image 'hello-world:latest' locally -:: latest: Pulling from library/hello-world -:: 1b930d010525: Pull complete -:: Digest: sha256:4fe721ccc2e8dc7362278a29dc660d833570ec2682f4e4194f4ee23e415e1064 -:: Status: Downloaded newer image for hello-world:latest -:: -:: Hello from Docker! -:: This message shows that your installation appears to be working correctly. -:: -:: To generate this message, Docker took the following steps: -:: 1. The Docker client contacted the Docker daemon. -:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. -:: (amd64) -:: 3. The Docker daemon created a new container from that image which runs the -:: executable that produces the output you are currently reading. -:: 4. The Docker daemon streamed that output to the Docker client, which sent it -:: to your terminal. -:: -:: To try something more ambitious, you can run an Ubuntu container with: -:: $ docker run -it ubuntu bash -:: -:: Share images, automate workflows, and more with a free Docker ID: -:: https://hub.docker.com/ -:: -:: For more examples and ideas, visit: -:: https://docs.docker.com/get-started/ -:: El susodicho mensaje se podría traducir como: -:: -:: Hola desde Docker! -:: Este mensaje muestra que su instalación parece estar funcionando crrectamente. -:: -:: Para generar este mensaje, Docker realizó los siguientes pasos: -:: 1. El cliente de Docker contactó a Docker daemon. -:: 2. El Docker daemon obtubo la imágen "hello-world" desde Docker Hub. -:: (amd64) -:: 3. El Docker daemon creó un nuevo contenedor a partir de esa imagen con la cual ejecuta el -:: ejecutable que produce la salida que estás leyendo. -:: 4. El Docker daemon transmitió dicha salida el cliente Docker, el cual -:: la envió a tu terminal. -:: -:: Para intentar algo más ambicioso, puede correr un contenedor Ubuntu mediante: -:: $ docker run -it ubuntu bash -:: -:: Comparte imágenes, automatice flujos y más con un Docker ID gratuito: -:: https://hub.docker.com/ - -:: ahora veamos las imágenes que se están ejecutando actualmente -docker ps -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES - -:: veamos las imágenes que hemos ejecutado previamente -docker ps -a - -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES -:: 4a76281f9c53 hello-world "/hello" 2 minutes ago Exited (0) 2 minutes ago -:: happy_poincare -:: la parte del nombre se genera automáticamente, así que probablemente sea diferente para vos - -:: eliminemos nuestra imagen previamente generada -docker rm happy_poincare - -:: verifiquemos si realmente fue borrada -docker ps -a -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES - -:: especifiquemos un nombre personalizado para el contenedor -docker run --name test_container hello-world -:: Hello from Docker! -:: This message shows that your installation appears to be working correctly. -:: -:: To generate this message, Docker took the following steps: -:: 1. The Docker client contacted the Docker daemon. -:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. -:: (amd64) -:: 3. The Docker daemon created a new container from that image which runs the -:: executable that produces the output you are currently reading. -:: 4. The Docker daemon streamed that output to the Docker client, which sent it -:: to your terminal. -:: -:: To try something more ambitious, you can run an Ubuntu container with: -:: $ docker run -it ubuntu bash -:: -:: Share images, automate workflows, and more with a free Docker ID: -:: https://hub.docker.com/ -:: -:: For more examples and ideas, visit: -:: https://docs.docker.com/get-started/ - -docker ps -a -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES -:: d345fe1a4f41 hello-world "/hello" About a minute ago Exited (0) About a minute ago -:: test_container -:: tal como podeis ver el nombre es el que especificamos - -:: obtener los registros de un contenedor nombrado -docker logs test_container -:: Hello from Docker! -:: This message shows that your installation appears to be working correctly. -:: -:: To generate this message, Docker took the following steps: -:: 1. The Docker client contacted the Docker daemon. -:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. -:: (amd64) -:: 3. The Docker daemon created a new container from that image which runs the -:: executable that produces the output you are currently reading. -:: 4. The Docker daemon streamed that output to the Docker client, which sent it -:: to your terminal. -:: -:: To try something more ambitious, you can run an Ubuntu container with: -:: $ docker run -it ubuntu bash -:: -:: Share images, automate workflows, and more with a free Docker ID: -:: https://hub.docker.com/ -:: -:: For more examples and ideas, visit: -:: https://docs.docker.com/get-started/ - -docker rm test_container - -docker run ubuntu -:: Unable to find image 'ubuntu:latest' locally -:: latest: Pulling from library/ubuntu -:: 2746a4a261c9: Pull complete -:: 4c1d20cdee96: Pull complete 0d3160e1d0de: Pull complete c8e37668deea: Pull complete Digest: sha256:250cc6f3f3ffc5cdaa9d8f4946ac79821aafb4d3afc93928f0de9336eba21aa4 -:: Status: Downloaded newer image for ubuntu:latest - -docker ps -a -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES -:: c19e9e5b000a ubuntu "/bin/bash" 5 seconds ago Exited (0) 4 seconds ago -:: relaxed_nobel - -:: ejecutando un contenedor en modo interactivo -docker run -it ubuntu -:: root@e2cac48323d2:/# uname -:: Linux -:: root@e2cac48323d2:/# exit -:: exit - -docker rm relaxed_nobel - -docker ps -a -:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS -:: NAMES -:: e2cac48323d2 ubuntu "/bin/bash" 2 minutes ago Exited (0) About a minute ago -:: nifty_goldwasser - -docker rm nifty_goldwasser -``` +--- +language: docker +filename: docker-es.bat +contributors: + - ["Ruslan López", "http://javapro.org/"] + - ["Michael Chen", "https://github.com/ML-Chen"] +lang: es-es +--- + +```bat +:: descargar, instalar y ejecutar la imágen del hola mundo +docker run hello-world + +:: Si esta es la primera vez, deberíais de poder ver el mensaje +:: Unable to find image 'hello-world:latest' locally +:: latest: Pulling from library/hello-world +:: 1b930d010525: Pull complete +:: Digest: sha256:4fe721ccc2e8dc7362278a29dc660d833570ec2682f4e4194f4ee23e415e1064 +:: Status: Downloaded newer image for hello-world:latest +:: +:: Hello from Docker! +:: This message shows that your installation appears to be working correctly. +:: +:: To generate this message, Docker took the following steps: +:: 1. The Docker client contacted the Docker daemon. +:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. +:: (amd64) +:: 3. The Docker daemon created a new container from that image which runs the +:: executable that produces the output you are currently reading. +:: 4. The Docker daemon streamed that output to the Docker client, which sent it +:: to your terminal. +:: +:: To try something more ambitious, you can run an Ubuntu container with: +:: $ docker run -it ubuntu bash +:: +:: Share images, automate workflows, and more with a free Docker ID: +:: https://hub.docker.com/ +:: +:: For more examples and ideas, visit: +:: https://docs.docker.com/get-started/ +:: El susodicho mensaje se podría traducir como: +:: +:: Hola desde Docker! +:: Este mensaje muestra que su instalación parece estar funcionando crrectamente. +:: +:: Para generar este mensaje, Docker realizó los siguientes pasos: +:: 1. El cliente de Docker contactó a Docker daemon. +:: 2. El Docker daemon obtubo la imágen "hello-world" desde Docker Hub. +:: (amd64) +:: 3. El Docker daemon creó un nuevo contenedor a partir de esa imagen con la cual ejecuta el +:: ejecutable que produce la salida que estás leyendo. +:: 4. El Docker daemon transmitió dicha salida el cliente Docker, el cual +:: la envió a tu terminal. +:: +:: Para intentar algo más ambicioso, puede correr un contenedor Ubuntu mediante: +:: $ docker run -it ubuntu bash +:: +:: Comparte imágenes, automatice flujos y más con un Docker ID gratuito: +:: https://hub.docker.com/ + +:: ahora veamos las imágenes que se están ejecutando actualmente +docker ps +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES + +:: veamos las imágenes que hemos ejecutado previamente +docker ps -a + +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES +:: 4a76281f9c53 hello-world "/hello" 2 minutes ago Exited (0) 2 minutes ago +:: happy_poincare +:: la parte del nombre se genera automáticamente, así que probablemente sea diferente para vos + +:: eliminemos nuestra imagen previamente generada +docker rm happy_poincare + +:: verifiquemos si realmente fue borrada +docker ps -a +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES + +:: especifiquemos un nombre personalizado para el contenedor +docker run --name test_container hello-world +:: Hello from Docker! +:: This message shows that your installation appears to be working correctly. +:: +:: To generate this message, Docker took the following steps: +:: 1. The Docker client contacted the Docker daemon. +:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. +:: (amd64) +:: 3. The Docker daemon created a new container from that image which runs the +:: executable that produces the output you are currently reading. +:: 4. The Docker daemon streamed that output to the Docker client, which sent it +:: to your terminal. +:: +:: To try something more ambitious, you can run an Ubuntu container with: +:: $ docker run -it ubuntu bash +:: +:: Share images, automate workflows, and more with a free Docker ID: +:: https://hub.docker.com/ +:: +:: For more examples and ideas, visit: +:: https://docs.docker.com/get-started/ + +docker ps -a +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES +:: d345fe1a4f41 hello-world "/hello" About a minute ago Exited (0) About a minute ago +:: test_container +:: tal como podeis ver el nombre es el que especificamos + +:: obtener los registros de un contenedor nombrado +docker logs test_container +:: Hello from Docker! +:: This message shows that your installation appears to be working correctly. +:: +:: To generate this message, Docker took the following steps: +:: 1. The Docker client contacted the Docker daemon. +:: 2. The Docker daemon pulled the "hello-world" image from the Docker Hub. +:: (amd64) +:: 3. The Docker daemon created a new container from that image which runs the +:: executable that produces the output you are currently reading. +:: 4. The Docker daemon streamed that output to the Docker client, which sent it +:: to your terminal. +:: +:: To try something more ambitious, you can run an Ubuntu container with: +:: $ docker run -it ubuntu bash +:: +:: Share images, automate workflows, and more with a free Docker ID: +:: https://hub.docker.com/ +:: +:: For more examples and ideas, visit: +:: https://docs.docker.com/get-started/ + +docker rm test_container + +docker run ubuntu +:: Unable to find image 'ubuntu:latest' locally +:: latest: Pulling from library/ubuntu +:: 2746a4a261c9: Pull complete +:: 4c1d20cdee96: Pull complete 0d3160e1d0de: Pull complete c8e37668deea: Pull complete Digest: sha256:250cc6f3f3ffc5cdaa9d8f4946ac79821aafb4d3afc93928f0de9336eba21aa4 +:: Status: Downloaded newer image for ubuntu:latest + +docker ps -a +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES +:: c19e9e5b000a ubuntu "/bin/bash" 5 seconds ago Exited (0) 4 seconds ago +:: relaxed_nobel + +:: ejecutando un contenedor en modo interactivo +docker run -it ubuntu +:: root@e2cac48323d2:/# uname +:: Linux +:: root@e2cac48323d2:/# exit +:: exit + +docker rm relaxed_nobel + +docker ps -a +:: CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS +:: NAMES +:: e2cac48323d2 ubuntu "/bin/bash" 2 minutes ago Exited (0) About a minute ago +:: nifty_goldwasser + +docker rm nifty_goldwasser +``` diff --git a/it-it/toml-it.html.markdown b/it-it/toml-it.html.markdown index 99082048..beb63096 100644 --- a/it-it/toml-it.html.markdown +++ b/it-it/toml-it.html.markdown @@ -1,276 +1,276 @@ ---- -language: toml -filename: learntoml-it.toml -contributors: - - ["Alois de Gouvello", "https://github.com/aloisdg"] -translators: - - ["Christian Grasso", "https://grasso.io"] -lang: it-it ---- - -TOML è l'acronimo di _Tom's Obvious, Minimal Language_. È un linguaggio per la -serializzazione di dati, progettato per i file di configurazione. - -È un'alternativa a linguaggi come YAML e JSON, che punta ad essere più leggibile -per le persone. Allo stesso tempo, TOML può essere utilizzato in modo abbastanza -semplice nella maggior parte dei linguaggi di programmazione, in quanto è -progettato per essere tradotto senza ambiguità in una hash table. - -Tieni presente che TOML è ancora in fase di sviluppo, e la sua specifica non è -ancora stabile. Questo documento utilizza TOML 0.4.0. - -```toml -# I commenti in TOML sono fatti così. - -################ -# TIPI SCALARI # -################ - -# Il nostro oggetto root (corrispondente all'intero documento) sarà una mappa, -# anche chiamata dizionario, hash o oggetto in altri linguaggi. - -# La key, il simbolo di uguale e il valore devono trovarsi sulla stessa riga, -# eccetto per alcuni tipi di valori. -key = "value" -stringa = "ciao" -numero = 42 -float = 3.14 -boolean = true -data = 1979-05-27T07:32:00-08:00 -notazScientifica = 1e+12 -"puoi utilizzare le virgolette per la key" = true # Puoi usare " oppure ' -"la key può contenere" = "lettere, numeri, underscore e trattini" - -############ -# Stringhe # -############ - -# Le stringhe possono contenere solo caratteri UTF-8 validi. -# Possiamo effettuare l'escape dei caratteri, e alcuni hanno delle sequenze -# di escape compatte. Ad esempio, \t corrisponde al TAB. -stringaSemplice = "Racchiusa tra virgolette. \"Usa il backslash per l'escape\"." - -stringaMultiriga = """ -Racchiusa da tre virgolette doppie all'inizio e -alla fine - consente di andare a capo.""" - -stringaLiteral = 'Virgolette singole. Non consente di effettuare escape.' - -stringaMultirigaLiteral = ''' -Racchiusa da tre virgolette singole all'inizio e -alla fine - consente di andare a capo. -Anche in questo caso non si può fare escape. -Il primo ritorno a capo viene eliminato. - Tutti gli altri spazi aggiuntivi - vengono mantenuti. -''' - -# Per i dati binari è consigliabile utilizzare Base64 e -# gestirli manualmente dall'applicazione. - -########## -# Interi # -########## - -## Gli interi possono avere o meno un segno (+, -). -## Non si possono inserire zero superflui all'inizio. -## Non è possibile inoltre utilizzare valori numerici -## non rappresentabili con una sequenza di cifre. -int1 = +42 -int2 = 0 -int3 = -21 - -## Puoi utilizzare gli underscore per migliorare la leggibilità. -## Fai attenzione a non inserirne due di seguito. -int4 = 5_349_221 -int5 = 1_2_3_4_5 # VALIDO, ma da evitare - -######### -# Float # -######### - -# I float permettono di rappresentare numeri decimali. -flt1 = 3.1415 -flt2 = -5e6 -flt3 = 6.626E-34 - -########### -# Boolean # -########### - -# I valori boolean (true/false) devono essere scritti in minuscolo. -bool1 = true -bool2 = false - -############ -# Data/ora # -############ - -data1 = 1979-05-27T07:32:00Z # Specifica RFC 3339/ISO 8601 (UTC) -data2 = 1979-05-26T15:32:00+08:00 # RFC 3339/ISO 8601 con offset - -###################### -# TIPI DI COLLECTION # -###################### - -######### -# Array # -######### - -array1 = [ 1, 2, 3 ] -array2 = [ "Le", "virgole", "sono", "delimitatori" ] -array3 = [ "Non", "unire", "tipi", "diversi" ] -array4 = [ "tutte", 'le stringhe', """hanno lo stesso""", '''tipo''' ] -array5 = [ - "Gli spazi vuoti", "sono", "ignorati" -] - -########### -# Tabelle # -########### - -# Le tabelle (o hash table o dizionari) sono collection di coppie key/value. -# Iniziano con un nome tra parentesi quadre su una linea separata. -# Le tabelle vuote (senza alcun valore) sono valide. -[tabella] - -# Tutti i valori che si trovano sotto il nome della tabella -# appartengono alla tabella stessa (finchè non ne viene creata un'altra). -# L'ordine di questi valori non è garantito. -[tabella-1] -key1 = "una stringa" -key2 = 123 - -[tabella-2] -key1 = "un'altra stringa" -key2 = 456 - -# Utilizzando i punti è possibile creare delle sottotabelle. -# Ogni parte suddivisa dai punti segue le regole delle key per il nome. -[tabella-3."sotto.tabella"] -key1 = "prova" - -# Ecco l'equivalente JSON della tabella precedente: -# { "tabella-3": { "sotto.tabella": { "key1": "prova" } } } - -# Gli spazi non vengono considerati, ma è consigliabile -# evitare di usare spazi superflui. -[a.b.c] # consigliato -[ d.e.f ] # identico a [d.e.f] - -# Non c'è bisogno di creare le tabelle superiori per creare una sottotabella. -# [x] queste -# [x.y] non -# [x.y.z] servono -[x.y.z.w] # per creare questa tabella - -# Se non è stata già creata prima, puoi anche creare -# una tabella superiore più avanti. -[a.b] -c = 1 - -[a] -d = 2 - -# Non puoi definire una key o una tabella più di una volta. - -# ERRORE -[a] -b = 1 - -[a] -c = 2 - -# ERRORE -[a] -b = 1 - -[a.b] -c = 2 - -# I nomi delle tabelle non possono essere vuoti. -[] # NON VALIDO -[a.] # NON VALIDO -[a..b] # NON VALIDO -[.b] # NON VALIDO -[.] # NON VALIDO - -################## -# Tabelle inline # -################## - -tabelleInline = { racchiuseData = "{ e }", rigaSingola = true } -punto = { x = 1, y = 2 } - -#################### -# Array di tabelle # -#################### - -# Un array di tabelle può essere creato utilizzando due parentesi quadre. -# Tutte le tabelle con questo nome saranno elementi dell'array. -# Gli elementi vengono inseriti nell'ordine in cui si trovano. - -[[prodotti]] -nome = "array di tabelle" -sku = 738594937 -tabelleVuoteValide = true - -[[prodotti]] - -[[prodotti]] -nome = "un altro item" -sku = 284758393 -colore = "grigio" - -# Puoi anche creare array di tabelle nested. Le sottotabelle con doppie -# parentesi quadre apparterranno alla tabella più vicina sopra di esse. - -[[frutta]] - nome = "mela" - - [frutto.geometria] - forma = "sferica" - nota = "Sono una proprietà del frutto" - - [[frutto.colore]] - nome = "rosso" - nota = "Sono un oggetto di un array dentro mela" - - [[frutto.colore]] - nome = "verde" - nota = "Sono nello stesso array di rosso" - -[[frutta]] - nome = "banana" - - [[frutto.colore]] - nome = "giallo" - nota = "Anche io sono un oggetto di un array, ma dentro banana" -``` - -Ecco l'equivalente JSON dell'ultima tabella: - -```json -{ - "frutta": [ - { - "nome": "mela", - "geometria": { "forma": "sferica", "nota": "..."}, - "colore": [ - { "nome": "rosso", "nota": "..." }, - { "nome": "verde", "nota": "..." } - ] - }, - { - "nome": "banana", - "colore": [ - { "nome": "giallo", "nota": "..." } - ] - } - ] -} -``` - -### Altre risorse - -+ [Repository ufficiale di TOML](https://github.com/toml-lang/toml) +--- +language: toml +filename: learntoml-it.toml +contributors: + - ["Alois de Gouvello", "https://github.com/aloisdg"] +translators: + - ["Christian Grasso", "https://grasso.io"] +lang: it-it +--- + +TOML è l'acronimo di _Tom's Obvious, Minimal Language_. È un linguaggio per la +serializzazione di dati, progettato per i file di configurazione. + +È un'alternativa a linguaggi come YAML e JSON, che punta ad essere più leggibile +per le persone. Allo stesso tempo, TOML può essere utilizzato in modo abbastanza +semplice nella maggior parte dei linguaggi di programmazione, in quanto è +progettato per essere tradotto senza ambiguità in una hash table. + +Tieni presente che TOML è ancora in fase di sviluppo, e la sua specifica non è +ancora stabile. Questo documento utilizza TOML 0.4.0. + +```toml +# I commenti in TOML sono fatti così. + +################ +# TIPI SCALARI # +################ + +# Il nostro oggetto root (corrispondente all'intero documento) sarà una mappa, +# anche chiamata dizionario, hash o oggetto in altri linguaggi. + +# La key, il simbolo di uguale e il valore devono trovarsi sulla stessa riga, +# eccetto per alcuni tipi di valori. +key = "value" +stringa = "ciao" +numero = 42 +float = 3.14 +boolean = true +data = 1979-05-27T07:32:00-08:00 +notazScientifica = 1e+12 +"puoi utilizzare le virgolette per la key" = true # Puoi usare " oppure ' +"la key può contenere" = "lettere, numeri, underscore e trattini" + +############ +# Stringhe # +############ + +# Le stringhe possono contenere solo caratteri UTF-8 validi. +# Possiamo effettuare l'escape dei caratteri, e alcuni hanno delle sequenze +# di escape compatte. Ad esempio, \t corrisponde al TAB. +stringaSemplice = "Racchiusa tra virgolette. \"Usa il backslash per l'escape\"." + +stringaMultiriga = """ +Racchiusa da tre virgolette doppie all'inizio e +alla fine - consente di andare a capo.""" + +stringaLiteral = 'Virgolette singole. Non consente di effettuare escape.' + +stringaMultirigaLiteral = ''' +Racchiusa da tre virgolette singole all'inizio e +alla fine - consente di andare a capo. +Anche in questo caso non si può fare escape. +Il primo ritorno a capo viene eliminato. + Tutti gli altri spazi aggiuntivi + vengono mantenuti. +''' + +# Per i dati binari è consigliabile utilizzare Base64 e +# gestirli manualmente dall'applicazione. + +########## +# Interi # +########## + +## Gli interi possono avere o meno un segno (+, -). +## Non si possono inserire zero superflui all'inizio. +## Non è possibile inoltre utilizzare valori numerici +## non rappresentabili con una sequenza di cifre. +int1 = +42 +int2 = 0 +int3 = -21 + +## Puoi utilizzare gli underscore per migliorare la leggibilità. +## Fai attenzione a non inserirne due di seguito. +int4 = 5_349_221 +int5 = 1_2_3_4_5 # VALIDO, ma da evitare + +######### +# Float # +######### + +# I float permettono di rappresentare numeri decimali. +flt1 = 3.1415 +flt2 = -5e6 +flt3 = 6.626E-34 + +########### +# Boolean # +########### + +# I valori boolean (true/false) devono essere scritti in minuscolo. +bool1 = true +bool2 = false + +############ +# Data/ora # +############ + +data1 = 1979-05-27T07:32:00Z # Specifica RFC 3339/ISO 8601 (UTC) +data2 = 1979-05-26T15:32:00+08:00 # RFC 3339/ISO 8601 con offset + +###################### +# TIPI DI COLLECTION # +###################### + +######### +# Array # +######### + +array1 = [ 1, 2, 3 ] +array2 = [ "Le", "virgole", "sono", "delimitatori" ] +array3 = [ "Non", "unire", "tipi", "diversi" ] +array4 = [ "tutte", 'le stringhe', """hanno lo stesso""", '''tipo''' ] +array5 = [ + "Gli spazi vuoti", "sono", "ignorati" +] + +########### +# Tabelle # +########### + +# Le tabelle (o hash table o dizionari) sono collection di coppie key/value. +# Iniziano con un nome tra parentesi quadre su una linea separata. +# Le tabelle vuote (senza alcun valore) sono valide. +[tabella] + +# Tutti i valori che si trovano sotto il nome della tabella +# appartengono alla tabella stessa (finchè non ne viene creata un'altra). +# L'ordine di questi valori non è garantito. +[tabella-1] +key1 = "una stringa" +key2 = 123 + +[tabella-2] +key1 = "un'altra stringa" +key2 = 456 + +# Utilizzando i punti è possibile creare delle sottotabelle. +# Ogni parte suddivisa dai punti segue le regole delle key per il nome. +[tabella-3."sotto.tabella"] +key1 = "prova" + +# Ecco l'equivalente JSON della tabella precedente: +# { "tabella-3": { "sotto.tabella": { "key1": "prova" } } } + +# Gli spazi non vengono considerati, ma è consigliabile +# evitare di usare spazi superflui. +[a.b.c] # consigliato +[ d.e.f ] # identico a [d.e.f] + +# Non c'è bisogno di creare le tabelle superiori per creare una sottotabella. +# [x] queste +# [x.y] non +# [x.y.z] servono +[x.y.z.w] # per creare questa tabella + +# Se non è stata già creata prima, puoi anche creare +# una tabella superiore più avanti. +[a.b] +c = 1 + +[a] +d = 2 + +# Non puoi definire una key o una tabella più di una volta. + +# ERRORE +[a] +b = 1 + +[a] +c = 2 + +# ERRORE +[a] +b = 1 + +[a.b] +c = 2 + +# I nomi delle tabelle non possono essere vuoti. +[] # NON VALIDO +[a.] # NON VALIDO +[a..b] # NON VALIDO +[.b] # NON VALIDO +[.] # NON VALIDO + +################## +# Tabelle inline # +################## + +tabelleInline = { racchiuseData = "{ e }", rigaSingola = true } +punto = { x = 1, y = 2 } + +#################### +# Array di tabelle # +#################### + +# Un array di tabelle può essere creato utilizzando due parentesi quadre. +# Tutte le tabelle con questo nome saranno elementi dell'array. +# Gli elementi vengono inseriti nell'ordine in cui si trovano. + +[[prodotti]] +nome = "array di tabelle" +sku = 738594937 +tabelleVuoteValide = true + +[[prodotti]] + +[[prodotti]] +nome = "un altro item" +sku = 284758393 +colore = "grigio" + +# Puoi anche creare array di tabelle nested. Le sottotabelle con doppie +# parentesi quadre apparterranno alla tabella più vicina sopra di esse. + +[[frutta]] + nome = "mela" + + [frutto.geometria] + forma = "sferica" + nota = "Sono una proprietà del frutto" + + [[frutto.colore]] + nome = "rosso" + nota = "Sono un oggetto di un array dentro mela" + + [[frutto.colore]] + nome = "verde" + nota = "Sono nello stesso array di rosso" + +[[frutta]] + nome = "banana" + + [[frutto.colore]] + nome = "giallo" + nota = "Anche io sono un oggetto di un array, ma dentro banana" +``` + +Ecco l'equivalente JSON dell'ultima tabella: + +```json +{ + "frutta": [ + { + "nome": "mela", + "geometria": { "forma": "sferica", "nota": "..."}, + "colore": [ + { "nome": "rosso", "nota": "..." }, + { "nome": "verde", "nota": "..." } + ] + }, + { + "nome": "banana", + "colore": [ + { "nome": "giallo", "nota": "..." } + ] + } + ] +} +``` + +### Altre risorse + ++ [Repository ufficiale di TOML](https://github.com/toml-lang/toml) diff --git a/make.html.markdown b/make.html.markdown index eecc96bf..f5352f9e 100644 --- a/make.html.markdown +++ b/make.html.markdown @@ -1,246 +1,246 @@ ---- -category: tool -tool: make -contributors: - - ["Robert Steed", "https://github.com/robochat"] - - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] -filename: Makefile ---- - -A Makefile defines a graph of rules for creating a target (or targets). -Its purpose is to do the minimum amount of work needed to update a -target to the most recent version of the source. Famously written over a -weekend by Stuart Feldman in 1976, it is still widely used (particularly -on Unix and Linux) despite many competitors and criticisms. - -There are many varieties of make in existence, however this article -assumes that we are using GNU make which is the standard on Linux. - -```make - -# Comments can be written like this. - -# File should be named Makefile and then can be run as `make `. -# Otherwise we use `make -f "filename" `. - -# Warning - only use TABS to indent in Makefiles, never spaces! - -#----------------------------------------------------------------------- -# Basics -#----------------------------------------------------------------------- - -# Rules are of the format -# target: -# where prerequisites are optional. - -# A rule - this rule will only run if file0.txt doesn't exist. -file0.txt: - echo "foo" > file0.txt - # Even comments in these 'recipe' sections get passed to the shell. - # Try `make file0.txt` or simply `make` - first rule is the default. - -# This rule will only run if file0.txt is newer than file1.txt. -file1.txt: file0.txt - cat file0.txt > file1.txt - # use the same quoting rules as in the shell. - @cat file0.txt >> file1.txt - # @ stops the command from being echoed to stdout. - -@echo 'hello' - # - means that make will keep going in the case of an error. - # Try `make file1.txt` on the commandline. - -# A rule can have multiple targets and multiple prerequisites -file2.txt file3.txt: file0.txt file1.txt - touch file2.txt - touch file3.txt - -# Make will complain about multiple recipes for the same rule. Empty -# recipes don't count though and can be used to add new dependencies. - -#----------------------------------------------------------------------- -# Phony Targets -#----------------------------------------------------------------------- - -# A phony target. Any target that isn't a file. -# It will never be up to date so make will always try to run it. -all: maker process - -# We can declare things out of order. -maker: - touch ex0.txt ex1.txt - -# Can avoid phony rules breaking when a real file has the same name by -.PHONY: all maker process -# This is a special target. There are several others. - -# A rule with a dependency on a phony target will always run -ex0.txt ex1.txt: maker - -# Common phony targets are: all make clean install ... - -#----------------------------------------------------------------------- -# Automatic Variables & Wildcards -#----------------------------------------------------------------------- - -process: file*.txt #using a wildcard to match filenames - @echo $^ # $^ is a variable containing the list of prerequisites - @echo $@ # prints the target name - #(for multiple target rules, $@ is whichever caused the rule to run) - @echo $< # the first prerequisite listed - @echo $? # only the dependencies that are out of date - @echo $+ # all dependencies including duplicates (unlike normal) - #@echo $| # all of the 'order only' prerequisites - -# Even if we split up the rule dependency definitions, $^ will find them -process: ex1.txt file0.txt -# ex1.txt will be found but file0.txt will be deduplicated. - -#----------------------------------------------------------------------- -# Patterns -#----------------------------------------------------------------------- - -# Can teach make how to convert certain files into other files. - -%.png: %.svg - inkscape --export-png $^ - -# Pattern rules will only do anything if make decides to create the -# target. - -# Directory paths are normally ignored when matching pattern rules. But -# make will try to use the most appropriate rule available. -small/%.png: %.svg - inkscape --export-png --export-dpi 30 $^ - -# make will use the last version for a pattern rule that it finds. -%.png: %.svg - @echo this rule is chosen - -# However make will use the first pattern rule that can make the target -%.png: %.ps - @echo this rule is not chosen if *.svg and *.ps are both present - -# make already has some pattern rules built-in. For instance, it knows -# how to turn *.c files into *.o files. - -# Older makefiles might use suffix rules instead of pattern rules -.png.ps: - @echo this rule is similar to a pattern rule. - -# Tell make about the suffix rule -.SUFFIXES: .png - -#----------------------------------------------------------------------- -# Variables -#----------------------------------------------------------------------- -# aka. macros - -# Variables are basically all string types - -name = Ted -name2="Sarah" - -echo: - @echo $(name) - @echo ${name2} - @echo $name # This won't work, treated as $(n)ame. - @echo $(name3) # Unknown variables are treated as empty strings. - -# There are 4 places to set variables. -# In order of priority from highest to lowest: -# 1: commandline arguments -# 2: Makefile -# 3: shell environment variables - make imports these automatically. -# 4: make has some predefined variables - -name4 ?= Jean -# Only set the variable if environment variable is not already defined. - -override name5 = David -# Stops commandline arguments from changing this variable. - -name4 +=grey -# Append values to variable (includes a space). - -# Pattern-specific variable values (GNU extension). -echo: name2 = Sara # True within the matching rule - # and also within its remade recursive dependencies - # (except it can break when your graph gets too complicated!) - -# Some variables defined automatically by make. -echo_inbuilt: - echo $(CC) - echo ${CXX} - echo $(FC) - echo ${CFLAGS} - echo $(CPPFLAGS) - echo ${CXXFLAGS} - echo $(LDFLAGS) - echo ${LDLIBS} - -#----------------------------------------------------------------------- -# Variables 2 -#----------------------------------------------------------------------- - -# The first type of variables are evaluated each time they are used. -# This can be expensive, so a second type of variable exists which is -# only evaluated once. (This is a GNU make extension) - -var := hello -var2 ::= $(var) hello -#:= and ::= are equivalent. - -# These variables are evaluated procedurally (in the order that they -# appear), thus breaking with the rest of the language ! - -# This doesn't work -var3 ::= $(var4) and good luck -var4 ::= good night - -#----------------------------------------------------------------------- -# Functions -#----------------------------------------------------------------------- - -# make has lots of functions available. - -sourcefiles = $(wildcard *.c */*.c) -objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) - -# Format is $(func arg0,arg1,arg2...) - -# Some examples -ls: * src/* - @echo $(filter %.txt, $^) - @echo $(notdir $^) - @echo $(join $(dir $^),$(notdir $^)) - -#----------------------------------------------------------------------- -# Directives -#----------------------------------------------------------------------- - -# Include other makefiles, useful for platform specific code -include foo.mk - -sport = tennis -# Conditional compilation -report: -ifeq ($(sport),tennis) - @echo 'game, set, match' -else - @echo "They think it's all over; it is now" -endif - -# There are also ifneq, ifdef, ifndef - -foo = true - -ifdef $(foo) -bar = 'hello' -endif -``` - -### More Resources - -+ [gnu make documentation](https://www.gnu.org/software/make/manual/) -+ [software carpentry tutorial](http://swcarpentry.github.io/make-novice/) -+ learn C the hard way [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) +--- +category: tool +tool: make +contributors: + - ["Robert Steed", "https://github.com/robochat"] + - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] +filename: Makefile +--- + +A Makefile defines a graph of rules for creating a target (or targets). +Its purpose is to do the minimum amount of work needed to update a +target to the most recent version of the source. Famously written over a +weekend by Stuart Feldman in 1976, it is still widely used (particularly +on Unix and Linux) despite many competitors and criticisms. + +There are many varieties of make in existence, however this article +assumes that we are using GNU make which is the standard on Linux. + +```make + +# Comments can be written like this. + +# File should be named Makefile and then can be run as `make `. +# Otherwise we use `make -f "filename" `. + +# Warning - only use TABS to indent in Makefiles, never spaces! + +#----------------------------------------------------------------------- +# Basics +#----------------------------------------------------------------------- + +# Rules are of the format +# target: +# where prerequisites are optional. + +# A rule - this rule will only run if file0.txt doesn't exist. +file0.txt: + echo "foo" > file0.txt + # Even comments in these 'recipe' sections get passed to the shell. + # Try `make file0.txt` or simply `make` - first rule is the default. + +# This rule will only run if file0.txt is newer than file1.txt. +file1.txt: file0.txt + cat file0.txt > file1.txt + # use the same quoting rules as in the shell. + @cat file0.txt >> file1.txt + # @ stops the command from being echoed to stdout. + -@echo 'hello' + # - means that make will keep going in the case of an error. + # Try `make file1.txt` on the commandline. + +# A rule can have multiple targets and multiple prerequisites +file2.txt file3.txt: file0.txt file1.txt + touch file2.txt + touch file3.txt + +# Make will complain about multiple recipes for the same rule. Empty +# recipes don't count though and can be used to add new dependencies. + +#----------------------------------------------------------------------- +# Phony Targets +#----------------------------------------------------------------------- + +# A phony target. Any target that isn't a file. +# It will never be up to date so make will always try to run it. +all: maker process + +# We can declare things out of order. +maker: + touch ex0.txt ex1.txt + +# Can avoid phony rules breaking when a real file has the same name by +.PHONY: all maker process +# This is a special target. There are several others. + +# A rule with a dependency on a phony target will always run +ex0.txt ex1.txt: maker + +# Common phony targets are: all make clean install ... + +#----------------------------------------------------------------------- +# Automatic Variables & Wildcards +#----------------------------------------------------------------------- + +process: file*.txt #using a wildcard to match filenames + @echo $^ # $^ is a variable containing the list of prerequisites + @echo $@ # prints the target name + #(for multiple target rules, $@ is whichever caused the rule to run) + @echo $< # the first prerequisite listed + @echo $? # only the dependencies that are out of date + @echo $+ # all dependencies including duplicates (unlike normal) + #@echo $| # all of the 'order only' prerequisites + +# Even if we split up the rule dependency definitions, $^ will find them +process: ex1.txt file0.txt +# ex1.txt will be found but file0.txt will be deduplicated. + +#----------------------------------------------------------------------- +# Patterns +#----------------------------------------------------------------------- + +# Can teach make how to convert certain files into other files. + +%.png: %.svg + inkscape --export-png $^ + +# Pattern rules will only do anything if make decides to create the +# target. + +# Directory paths are normally ignored when matching pattern rules. But +# make will try to use the most appropriate rule available. +small/%.png: %.svg + inkscape --export-png --export-dpi 30 $^ + +# make will use the last version for a pattern rule that it finds. +%.png: %.svg + @echo this rule is chosen + +# However make will use the first pattern rule that can make the target +%.png: %.ps + @echo this rule is not chosen if *.svg and *.ps are both present + +# make already has some pattern rules built-in. For instance, it knows +# how to turn *.c files into *.o files. + +# Older makefiles might use suffix rules instead of pattern rules +.png.ps: + @echo this rule is similar to a pattern rule. + +# Tell make about the suffix rule +.SUFFIXES: .png + +#----------------------------------------------------------------------- +# Variables +#----------------------------------------------------------------------- +# aka. macros + +# Variables are basically all string types + +name = Ted +name2="Sarah" + +echo: + @echo $(name) + @echo ${name2} + @echo $name # This won't work, treated as $(n)ame. + @echo $(name3) # Unknown variables are treated as empty strings. + +# There are 4 places to set variables. +# In order of priority from highest to lowest: +# 1: commandline arguments +# 2: Makefile +# 3: shell environment variables - make imports these automatically. +# 4: make has some predefined variables + +name4 ?= Jean +# Only set the variable if environment variable is not already defined. + +override name5 = David +# Stops commandline arguments from changing this variable. + +name4 +=grey +# Append values to variable (includes a space). + +# Pattern-specific variable values (GNU extension). +echo: name2 = Sara # True within the matching rule + # and also within its remade recursive dependencies + # (except it can break when your graph gets too complicated!) + +# Some variables defined automatically by make. +echo_inbuilt: + echo $(CC) + echo ${CXX} + echo $(FC) + echo ${CFLAGS} + echo $(CPPFLAGS) + echo ${CXXFLAGS} + echo $(LDFLAGS) + echo ${LDLIBS} + +#----------------------------------------------------------------------- +# Variables 2 +#----------------------------------------------------------------------- + +# The first type of variables are evaluated each time they are used. +# This can be expensive, so a second type of variable exists which is +# only evaluated once. (This is a GNU make extension) + +var := hello +var2 ::= $(var) hello +#:= and ::= are equivalent. + +# These variables are evaluated procedurally (in the order that they +# appear), thus breaking with the rest of the language ! + +# This doesn't work +var3 ::= $(var4) and good luck +var4 ::= good night + +#----------------------------------------------------------------------- +# Functions +#----------------------------------------------------------------------- + +# make has lots of functions available. + +sourcefiles = $(wildcard *.c */*.c) +objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) + +# Format is $(func arg0,arg1,arg2...) + +# Some examples +ls: * src/* + @echo $(filter %.txt, $^) + @echo $(notdir $^) + @echo $(join $(dir $^),$(notdir $^)) + +#----------------------------------------------------------------------- +# Directives +#----------------------------------------------------------------------- + +# Include other makefiles, useful for platform specific code +include foo.mk + +sport = tennis +# Conditional compilation +report: +ifeq ($(sport),tennis) + @echo 'game, set, match' +else + @echo "They think it's all over; it is now" +endif + +# There are also ifneq, ifdef, ifndef + +foo = true + +ifdef $(foo) +bar = 'hello' +endif +``` + +### More Resources + ++ [gnu make documentation](https://www.gnu.org/software/make/manual/) ++ [software carpentry tutorial](http://swcarpentry.github.io/make-novice/) ++ learn C the hard way [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) diff --git a/opengl.html.markdown b/opengl.html.markdown index 993402f7..f6a9085f 100644 --- a/opengl.html.markdown +++ b/opengl.html.markdown @@ -1,765 +1,765 @@ ---- -category: tool -tool: OpenGL -filename: learnopengl.cpp -contributors: - - ["Simon Deitermann", "s.f.deitermann@t-online.de"] ---- - -**Open Graphics Library** (**OpenGL**) is a cross-language cross-platform application programming interface -(API) for rendering 2D computer graphics and 3D vector graphics.[1] In this tutorial we will be -focusing on modern OpenGL from 3.3 and above, ignoring "immediate-mode", Displaylists and -VBO's without use of Shaders. -I will be using C++ with SFML for window, image and context creation aswell as GLEW -for modern OpenGL extensions, though there are many other librarys available. - -```cpp -// Creating an SFML window and OpenGL basic setup. -#include -#include -#include -#include - -int main() { - // First we tell SFML how to setup our OpenGL context. - sf::ContextSettings context{ 24, // depth buffer bits - 8, // stencil buffer bits - 4, // MSAA samples - 3, // major opengl version - 3 }; // minor opengl version - // Now we create the window, enable VSync - // and set the window active for OpenGL. - sf::Window window{ sf::VideoMode{ 1024, 768 }, - "opengl window", - sf::Style::Default, - context }; - window.setVerticalSyncEnabled(true); - window.setActive(true); - // After that we initialise GLEW and check if an error occurred. - GLenum error; - glewExperimental = GL_TRUE; - if ((err = glewInit()) != GLEW_OK) - std::cout << glewGetErrorString(err) << std::endl; - // Here we set the color glClear will clear the buffers with. - glClearColor(0.0f, // red - 0.0f, // green - 0.0f, // blue - 1.0f); // alpha - // Now we can start the event loop, poll for events and draw objects. - sf::Event event{ }; - while (window.isOpen()) { - while (window.pollEvent(event)) { - if (event.type == sf::Event::Closed) - window.close; - } - // Tell OpenGL to clear the color buffer - // and the depth buffer, this will clear our window. - glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); - // Flip front- and backbuffer. - window.display(); - } - return 0; -} -``` - -## Loading Shaders - -After creating a window and our event loop we should create a function, -that sets up our shader program. - -```cpp -GLuint createShaderProgram(const std::string& vertexShaderPath, - const std::string& fragmentShaderPath) { - // Load the vertex shader source. - std::stringstream ss{ }; - std::string vertexShaderSource{ }; - std::string fragmentShaderSource{ }; - std::ifstream file{ vertexShaderPath }; - if (file.is_open()) { - ss << file.rdbuf(); - vertexShaderSource = ss.str(); - file.close(); - } - // Clear the stringstream and load the fragment shader source. - ss.str(std::string{ }); - file.open(fragmentShaderPath); - if (file.is_open()) { - ss << file.rdbuf(); - fragmentShaderSource = ss.str(); - file.close(); - } - // Create the program. - GLuint program = glCreateProgram(); - // Create the shaders. - GLuint vertexShader = glCreateShader(GL_VERTEX_SHADER); - GLuint fragmentShader = glCreateShader(GL_FRAGMENT_SHADER); - // Now we can load the shader source into the shader objects and compile them. - // Because glShaderSource() wants a const char* const*, - // we must first create a const char* and then pass the reference. - const char* cVertexSource = vertexShaderSource.c_str(); - glShaderSource(vertexShader, // shader - 1, // number of strings - &cVertexSource, // strings - nullptr); // length of strings (nullptr for 1) - glCompileShader(vertexShader); - // Now we have to do the same for the fragment shader. - const char* cFragmentSource = fragmentShaderSource.c_str(); - glShaderSource(fragmentShader, 1, &cFragmentSource, nullptr); - glCompileShader(fragmentShader); - // After attaching the source and compiling the shaders, - // we attach them to the program; - glAttachShader(program, vertexShader); - glAttachShader(program, fragmentShader); - glLinkProgram(program); - // After linking the shaders we should detach and delete - // them to prevent memory leak. - glDetachShader(program, vertexShader); - glDetachShader(program, fragmentShader); - glDeleteShader(vertexShader); - glDeleteShader(fragmentShader); - // With everything done we can return the completed program. - return program; -} -``` - -If you want to check the compilation log you can add the following between glCompileShader() and glAttachShader(). - -```cpp -GLint logSize = 0; -std::vector logText{ }; -glGetShaderiv(vertexShader, // shader - GL_INFO_LOG_LENGTH, // requested parameter - &logSize); // return object -if (logSize > 0) { - logText.resize(logSize); - glGetShaderInfoLog(vertexShader, // shader - logSize, // buffer length - &logSize, // returned length - logText.data()); // buffer - std::cout << logText.data() << std::endl; -} -``` - -The same is possible after glLinkProgram(), just replace glGetShaderiv() with glGetProgramiv() -and glGetShaderInfoLog() with glGetProgramInfoLog(). - -```cpp -// Now we can create a shader program with a vertex and a fragment shader. -// ... -glClearColor(0.0f, 0.0f, 0.0f, 1.0f); - -GLuint program = createShaderProgram("vertex.glsl", "fragment.glsl"); - -sf::Event event{ }; -// ... -// We also have to delete the program at the end of the application. -// ... - } - glDeleteProgram(program); - return 0; -} -// ... -``` - -Ofcourse we have to create the vertex and fragment shader before we can load them, -so lets create two basic shaders. - -**Vertex Shader** - -```glsl -// Declare which version of GLSL we use. -// Here we declare, that we want to use the OpenGL 3.3 version of GLSL. -#version 330 core -// At attribute location 0 we want an input variable of type vec3, -// that contains the position of the vertex. -// Setting the location is optional, if you don't set it you can ask for the -// location with glGetAttribLocation(). -layout(location = 0) in vec3 position; -// Every shader starts in it's main function. -void main() { - // gl_Position is a predefined variable that holds - // the final vertex position. - // It consists of a x, y, z and w coordinate. - gl_Position = vec4(position, 1.0); -} -``` - -**Fragment Shader** - -```glsl -#version 330 core -// The fragment shader does not have a predefined variable for -// the vertex color, so we have to define a output vec4, -// that holds the final vertex color. -out vec4 outColor; - -void main() { - // We simply set the output color to red. - // The parameters are red, green, blue and alpha. - outColor = vec4(1.0, 0.0, 0.0, 1.0); -} -``` - -## VAO and VBO -Now we need to define some vertex position we can pass to our shaders. Lets define a simple 2D quad. - -```cpp -// The vertex data is defined in a counter-clockwise way, -// as this is the default front face. -std::vector vertexData { - -0.5f, 0.5f, 0.0f, - -0.5f, -0.5f, 0.0f, - 0.5f, -0.5f, 0.0f, - 0.5f, 0.5f, 0.0f -}; -// If you want to use a clockwise definition, you can simply call -glFrontFace(GL_CW); -// Next we need to define a Vertex Array Object (VAO). -// The VAO stores the current state while its active. -GLuint vao = 0; -glGenVertexArrays(1, &vao); -glBindVertexArray(vao); -// With the VAO active we can now create a Vertex Buffer Object (VBO). -// The VBO stores our vertex data. -GLuint vbo = 0; -glGenBuffers(1, &vbo); -glBindBuffer(GL_ARRAY_BUFFER, vbo); -// For reading and copying there are also GL_*_READ and GL_*_COPY, -// if your data changes more often use GL_DYNAMIC_* or GL_STREAM_*. -glBufferData(GL_ARRAY_BUFFER, // target buffer - sizeof(vertexData[0]) * vertexData.size(), // size - vertexData.data(), // data - GL_STATIC_DRAW); // usage -// After filling the VBO link it to the location 0 in our vertex shader, -// which holds the vertex position. -// ... -// To ask for the attribute location, if you haven't set it: -GLint posLocation = glGetAttribLocation(program, "position"); -// .. -glEnableVertexAttribArray(0); -glVertexAttribPointer(0, 3, // location and size - GL_FLOAT, // type of data - GL_FALSE, // normalized (always false for floats) - 0, // stride (interleaved arrays) - nullptr); // offset (interleaved arrays) -// Everything should now be saved in our VAO and we can unbind it and the VBO. -glBindVertexArray(0); -glBindBuffer(GL_ARRAY_BUFFER, 0); -// Now we can draw the vertex data in our render loop. -// ... -glClear(GL_COLOR_BUFFER_BIT); -// Tell OpenGL we want to use our shader program. -glUseProgram(program); -// Binding the VAO loads the data we need. -glBindVertexArray(vao); -// We want to draw a quad starting at index 0 of the VBO using 4 indices. -glDrawArrays(GL_QUADS, 0, 4); -glBindVertexArray(0); -window.display(); -// ... -// Ofcource we have to delete the allocated memory for the VAO and VBO at -// the end of our application. -// ... -glDeleteBuffers(1, &vbo); -glDeleteVertexArrays(1, &vao); -glDeleteProgram(program); -return 0; -// ... -``` - -You can find the current code here: [OpenGL - 1](https://pastebin.com/W8jdmVHD). - -## More VBO's and Color -Let's create another VBO for some colors. - -```cpp -std::vector colorData { - 1.0f, 0.0f, 0.0f, - 0.0f, 1.0f, 0.0f, - 0.0f, 0.0f, 1.0f, - 1.0f, 1.0f, 0.0f -}; -``` - -Next we can simply change some previous parameters to create a second VBO for our colors. - -```cpp -// ... -GLuint vbo[2]; -glGenBuffers(2, vbo); -glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); -// ... -glDeleteBuffers(2, vbo); -/ ... -// With these changes made we now have to load our color data into the new VBO -// ... -glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 0, nullptr); - -glBindBuffer(GL_ARRAY_BUFFER, vbo[1]); -glBufferData(GL_ARRAY_BUFFER, sizeof(colorData[0]) * colorData.size(), - colorData.data(), GL_STATIC_DRAW); -glEnableVertexAttribArray(1); -glVertexAttribPointer(1, 3, GL_FLOAT, GL_FALSE, 0, nullptr); - -glBindVertexArray(0); -// ... -``` - -Next we have to change our vertex shader to pass the color data to the fragment shader.
-**Vertex Shader** - -```glsl -#version 330 core - -layout(location = 0) in vec3 position; -// The new location has to differ from any other input variable. -// It is the same index we need to pass to -// glEnableVertexAttribArray() and glVertexAttribPointer(). -layout(location = 1) in vec3 color; - -out vec3 fColor; - -void main() { - fColor = color; - gl_Position = vec4(position, 1.0); -} -``` - -**Fragment Shader** - -```glsl -#version 330 core - -in vec3 fColor; - -out vec4 outColor; - -void main() { - outColor = vec4(fColor, 1.0); -} -``` - -We define a new input variable ```color``` which represents our color data, this data -is passed on to ```fColor```, which is an output variable of our vertex shader and -becomes an input variable for our fragment shader. -It is imporatant that variables passed between shaders have the exact same name -and type. - -## Handling VBO's - -```cpp -// If you want to completely clear and refill a VBO use glBufferData(), -// just like we did before. -// ... -// There are two mains ways to update a subset of a VBO's data. -// To update a VBO with existing data -std::vector newSubData { - -0.25f, 0.5f, 0.0f -}; -glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); -glBufferSubData(GL_ARRAY_BUFFER, // target buffer - 0, // offset - sizeof(newSubData[0]) * newSubData.size(), // size - newSubData.data()); // data -// This would update the first three values in our vbo[0] buffer. -// If you want to update starting at a specific location just set the second -// parameter to that value and multiply by the types size. -// ... -// If you are streaming data, for example from a file, -// it is faster to directly pass the data to the buffer. -// Other access values are GL_READ_ONLY and GL_READ_WRITE. -glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); -// You can static_cast() the void* to be more safe. -void* Ptr = glMapBuffer(GL_ARRAY_BUFFER, // buffer to map - GL_WRITE_ONLY); // access to buffer -memcpy(Ptr, newSubData.data(), sizeof(newSubData[0]) * newSubData.size()); -// To copy to a specific location add a destination offset to memcpy(). -glUnmapBuffer(GL_ARRAY_BUFFER); -// ... -// There is also a way to copy data from one buffer to another, -// If we have two VBO's vbo[0] and vbo[1], we can copy like so -// You can also read from GL_ARRAY_BUFFER. -glBindBuffer(GL_COPY_READ_BUFFER, vbo[0]); -// GL_COPY_READ_BUFFER and GL_COPY_WRITE_BUFFER are specifically for -// copying buffer data. -glBindBuffer(GL_COPY_WRITE_BUFFER, vbo[1]); -glCopyBufferSubData(GL_COPY_READ_BUFFER, // read buffer - GL_COPY_WRITE_BUFFER, // write buffer - 0, 0, // read and write offset - sizeof(vbo[0]) * 3); // copy size -// This will copy the first three elements from vbo[0] to vbo[1]. -``` - -## Uniforms - -**Fragment Shader** - -```glsl -// Uniforms are variables like in and out, however, -// we can change them easily by passing new values with glUniform(). -// Lets define a time variable in our fragment shader. -#version 330 core -// Unlike a in/out variable we can use a uniform in every shader, -// without the need to pass it to the next one, they are global. -// Don't use locations already used for attributes! -// Uniform layout locations require OpenGL 4.3! -layout(location = 10) uniform float time; - -in vec3 fColor; - -out vec4 outColor; - -void main() { - // Create a sine wave from 0 to 1 based on the time passed to the shader. - float factor = (sin(time * 2) + 1) / 2; - outColor = vec4(fColor.r * factor, fColor.g * factor, fColor.b * factor, 1.0); -} -``` - -Back to our source code. - -```cpp -// If we haven't set the layout location, we can ask for it. -GLint timeLocation = glGetUniformLocation(program, "time"); -// ... -// Also we should define a Timer counting the current time. -sf::Clock clock{ }; -// In out render loop we can now update the uniform every frame. - // ... - window.display(); - glUniform1f(10, // location - clock.getElapsedTime().asSeconds()); // data -} -// ... -``` - -With the time getting updated every frame the quad should now be changing from -fully colored to pitch black. -There are different types of glUniform() you can find simple documentation here: -[glUniform - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glUniform.xhtml) - -## Indexing and IBO's - -Element Array Buffers or more commonly Index Buffer Objects (IBO) allow us to use the -same vertex data again which makes drawing a lot easier and faster. here's an example: - -```cpp -// Lets create a quad from two rectangles. -// We can simply use the old vertex data from before. -// First, we have to create the IBO. -// The index is referring to the first declaration in the VBO. -std::vector iboData { - 0, 1, 2, - 0, 2, 3 -}; -// That's it, as you can see we could reuse 0 - the top left -// and 2 - the bottom right. -// Now that we have our data, we have to fill it into a buffer. -// Note that this has to happen between the two glBindVertexArray() calls, -// so it gets saved into the VAO. -GLuint ibo = 0; -glGenBufferrs(1, &ibo); -glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ibo); -glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(iboData[0]) * iboData.size(), - iboData.data(), GL_STATIC_DRAW); -// Next in our render loop, we replace glDrawArrays() with: -glDrawElements(GL_TRIANGLES, iboData.size(), GL_UNSIGNED_INT, nullptr); -// Remember to delete the allocated memory for the IBO. -``` - -You can find the current code here: [OpenGL - 2](https://pastebin.com/R3Z9ACDE). - -## Textures - -To load out texture we first need a library that loads the data, for simplicity I will be -using SFML, however there are a lot of librarys for loading image data. - -```cpp -// Lets save we have a texture called "my_tex.tga", we can load it with: -sf::Image image; -image.loadFromFile("my_tex.tga"); -// We have to flip the texture around the y-Axis, because OpenGL's texture -// origin is the bottom left corner, not the top left. -image.flipVertically(); -// After loading it we have to create a OpenGL texture. -GLuint texture = 0; -glGenTextures(1, &texture); -glBindTexture(GL_TEXTURE_2D, texture); -// Specify what happens when the coordinates are out of range. -glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT); -glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT); -// Specify the filtering if the object is very large. -glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); -glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); -// Load the image data to the texture. -glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, image.getSize().x, image.getSize().y, - 0, GL_RGBA, GL_UNSIGNED_BYTE, image.getPixelsPtr()); -// Unbind the texture to prevent modifications. -glBindTexture(GL_TEXTURE_2D, 0); -// Delete the texture at the end of the application. -// ... -glDeleteTextures(1, &texture); -``` - -Ofcourse there are more texture formats than only 2D textures, -You can find further information on parameters here: -[glBindTexture - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glBindTexture.xhtml)
-[glTexImage2D - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glTexImage2D.xhtml)
-[glTexParameter - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glTexParameter.xhtml)
- -```cpp -// With the texture created, we now have to specify the UV, -// or in OpenGL terms ST coordinates. -std::vector texCoords { - // The texture coordinates have to match the triangles/quad - // definition. - 0.0f, 1.0f, // start at top-left - 0.0f, 0.0f, // go round counter-clockwise - 1.0f, 0.0f, - 1.0f, 1.0f // end at top-right -}; -// Now we increase the VBO's size again just like we did for the colors. -// ... -GLuint vbo[3]; -glGenBuffers(3, vbo); -// ... -glDeleteBuffers(3, vbo); -// ... -// Load the texture coordinates into the new buffer. -glBindBuffer(GL_ARRAY_BUFFER, vbo[2]); -glBufferData(GL_ARRAY_BUFFER, sizeof(texCoords[0]) * texCoords.size(), - texCoords.data(), GL_STATIC_DRAW); -glEnableVertexAttribArray(2); -glVertexAttribPointer(2, 2, GL_FLOAT, GL_FALSE, 0, nullptr); -// Because the VAO does not store the texture we have to bind it before drawing. -// ... -glBindVertexArray(vao); -glBindTexture(GL_TEXTURE_2D, texture); -glDrawElements(GL_TRIANGLES, iboData.size(), GL_UNSIGNED_INT, nullptr); -// ... -``` - -Change the shaders to pass the data to the fragment shader.
- -**Vertex Shader** - -```glsl -#version 330 core - -layout(location = 0) in vec3 position; -layout(location = 1) in vec3 color; -layout(location = 2) in vec2 texCoords; - -out vec3 fColor; -out vec2 fTexCoords; - -void main() { - fColor = color; - fTexCoords = texCoords; - gl_Position = vec4(position, 1.0); -} -``` - -**Fragment Shader** - -```glsl -#version 330 core -// sampler2D represents our 2D texture. -uniform sampler2D tex; -uniform float time; - -in vec3 fColor; -in vec2 fTexCoords; - -out vec4 outColor; - -void main() { - // texture() loads the current texure data at the specified texture coords, - // then we can simply multiply them by our color. - outColor = texture(tex, fTexCoords) * vec4(fColor, 1.0); -} -``` - -You can find the current code here: [OpenGL - 3](https://pastebin.com/u3bcwM6q) - -## Matrix Transformation - -**Vertex Shader** - -```glsl -#version 330 core - -layout(location = 0) in vec3 position; -layout(location = 1) in vec3 color; -layout(location = 2) in vec2 texCoords; -// Create 2 4x4 matricies, 1 for the projection matrix -// and 1 for the model matrix. -// Because we draw in a static scene, we don't need a view matrix. -uniform mat4 projection; -uniform mat4 model; - -out vec3 fColor; -out vec2 fTexCoords; - -void main() { - fColor = color; - fTexCoords = texCoords; - // Multiplay the position by the model matrix and then by the - // projection matrix. - // Beware order of multiplication for matricies! - gl_Position = projection * model * vec4(position, 1.0); -} -``` - -In our source we now need to change the vertex data, create a model- and a projection matrix. - -```cpp -// The new vertex data, counter-clockwise declaration. -std::vector vertexData { - 0.0f, 1.0f, 0.0f, // top left - 0.0f, 0.0f, 0.0f, // bottom left - 1.0f, 0.0f, 0.0f, // bottom right - 1.0f, 1.0f, 0.0f // top right -}; -// Request the location of our matricies. -GLint projectionLocation = glGetUniformLocation(program, "projection"); -GLint modelLocation = glGetUniformLocation(program, "model"); -// Declaring the matricies. -// Orthogonal matrix for a 1024x768 window. -std::vector projection { - 0.001953f, 0.0f, 0.0f, 0.0f, - 0.0f, -0.002604f, 0.0f, 0.0f, - 0.0f, 0.0f, -1.0f, 0.0f, - -1.0f, 1.0f, 0.0f, 1.0f -}; -// Model matrix translating to x 50, y 50 -// and scaling to x 200, y 200. -std::vector model { - 200.0f, 0.0f, 0.0f, 0.0f, - 0.0f, 200.0f, 0.0f, 0.0f, - 0.0f, 0.0f, 1.0f, 0.0f, - 50.0f, 50.0f, 0.0f, 1.0f -}; -// Now we can send our calculated matricies to the program. -glUseProgram(program); -glUniformMatrix4fv(projectionLocation, // location - 1, // count - GL_FALSE, // transpose the matrix - projection.data()); // data -glUniformMatrix4fv(modelLocation, 1, GL_FALSE, model.data()); -glUseProgram(0); -// The glUniform*() calls have to be done, while the program is bound. -``` - -The application should now display the texture at the defined position and size.
-You can find the current code here: [OpenGL - 4](https://pastebin.com/9ahpFLkY) - -```cpp -// There are many math librarys for OpenGL, which create -// matricies and vectors, the most used in C++ is glm (OpenGL Mathematics). -// Its a header only library. -// The same code using glm would look like: -glm::mat4 projection{ glm::ortho(0.0f, 1024.0f, 768.0f, 0.0f) }; -glUniformMatrix4fv(projectionLocation, 1, GL_FALSE, - glm::value_ptr(projection)); -// Initialise the model matrix to the identity matrix, otherwise every -// multiplication would be 0. -glm::mat4 model{ 1.0f }; -model = glm::translate(model, glm::vec3{ 50.0f, 50.0f, 0.0f }); -model = glm::scale(model, glm::vec3{ 200.0f, 200.0f, 0.0f }); -glUniformMatrix4fv(modelLocation, 1, GL_FALSE, - glm::value_ptr(model)); -``` - -## Geometry Shader - -Geometry shaders were introduced in OpenGL 3.2, they can produce vertices -that are send to the rasterizer. They can also change the primitive type e.g. -they can take a point as an input and output other primitives. -Geometry shaders are inbetween the vertex and the fragment shader. - -**Vertex Shader** - -```glsl -#version 330 core - -layout(location = 0) in vec3 position; -layout(location = 1) in vec3 color; -// Create an output interface block passed to the next shadaer stage. -// Interface blocks can be used to structure data passed between shaders. -out VS_OUT { - vec3 color; -} vs_out; - -void main() { - vs_out.color = color - gl_Position = vec4(position, 1.0); -} -``` - -**Geometry Shader** - -```glsl -#version 330 core -// The geometry shader takes in points. -layout(points) in; -// It outputs a triangle every 3 vertices emitted. -layout(triangle_strip, max_vertices = 3) out; -// VS_OUT becomes an input variable in the geometry shader. -// Every input to the geometry shader in treated as an array. -in VS_OUT { - vec3 color; -} gs_in[]; -// Output color for the fragment shader. -// You can also simply define color as 'out vec3 color', -// If you don't want to use interface blocks. -out GS_OUT { - vec3 color; -} gs_out; - -void main() { - // Each emit calls the fragment shader, so we set a color for each vertex. - gs_out.color = mix(gs_in[0].color, vec3(1.0, 0.0, 0.0), 0.5); - // Move 0.5 units to the left and emit the new vertex. - // gl_in[] is the current vertex from the vertex shader, here we only - // use 0, because we are receiving points. - gl_Position = gl_in[0].gl_Position + vec4(-0.5, 0.0, 0.0, 0.0); - EmitVertex(); - gs_out.color = mix(gs_in[0].color, vec3(0.0, 1.0, 0.0), 0.5); - // Move 0.5 units to the right and emit the new vertex. - gl_Position = gl_in[0].gl_Position + vec4(0.5, 0.0, 0.0, 0.0); - EmitVertex(); - gs_out.color = mix(gs_in[0].color, vec3(0.0, 0.0, 1.0), 0.5); - // Move 0.5 units up and emit the new vertex. - gl_Position = gl_in[0].gl_Position + vec4(0.0, 0.75, 0.0, 0.0); - EmitVertex(); - EndPrimitive(); -} -``` - -**Fragment Shader** - -```glsl -in GS_OUT { - vec3 color; -} fs_in; - -out vec4 outColor; - -void main() { - outColor = vec4(fs_in.color, 1.0); -} -``` - -If you now store a single point with a single color in a VBO and draw them, -you should see a triangle, with your color mixed half way between -red, green and blue on each vertex. - - -## Quotes -[1][OpenGL - Wikipedia](https://en.wikipedia.org/wiki/OpenGL) - -## Books - -- OpenGL Superbible - Fifth Edition (covering OpenGL 3.3) -- OpenGL Programming Guide - Eighth Edition (covering OpenGL 4.3) +--- +category: tool +tool: OpenGL +filename: learnopengl.cpp +contributors: + - ["Simon Deitermann", "s.f.deitermann@t-online.de"] +--- + +**Open Graphics Library** (**OpenGL**) is a cross-language cross-platform application programming interface +(API) for rendering 2D computer graphics and 3D vector graphics.[1] In this tutorial we will be +focusing on modern OpenGL from 3.3 and above, ignoring "immediate-mode", Displaylists and +VBO's without use of Shaders. +I will be using C++ with SFML for window, image and context creation aswell as GLEW +for modern OpenGL extensions, though there are many other librarys available. + +```cpp +// Creating an SFML window and OpenGL basic setup. +#include +#include +#include +#include + +int main() { + // First we tell SFML how to setup our OpenGL context. + sf::ContextSettings context{ 24, // depth buffer bits + 8, // stencil buffer bits + 4, // MSAA samples + 3, // major opengl version + 3 }; // minor opengl version + // Now we create the window, enable VSync + // and set the window active for OpenGL. + sf::Window window{ sf::VideoMode{ 1024, 768 }, + "opengl window", + sf::Style::Default, + context }; + window.setVerticalSyncEnabled(true); + window.setActive(true); + // After that we initialise GLEW and check if an error occurred. + GLenum error; + glewExperimental = GL_TRUE; + if ((err = glewInit()) != GLEW_OK) + std::cout << glewGetErrorString(err) << std::endl; + // Here we set the color glClear will clear the buffers with. + glClearColor(0.0f, // red + 0.0f, // green + 0.0f, // blue + 1.0f); // alpha + // Now we can start the event loop, poll for events and draw objects. + sf::Event event{ }; + while (window.isOpen()) { + while (window.pollEvent(event)) { + if (event.type == sf::Event::Closed) + window.close; + } + // Tell OpenGL to clear the color buffer + // and the depth buffer, this will clear our window. + glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); + // Flip front- and backbuffer. + window.display(); + } + return 0; +} +``` + +## Loading Shaders + +After creating a window and our event loop we should create a function, +that sets up our shader program. + +```cpp +GLuint createShaderProgram(const std::string& vertexShaderPath, + const std::string& fragmentShaderPath) { + // Load the vertex shader source. + std::stringstream ss{ }; + std::string vertexShaderSource{ }; + std::string fragmentShaderSource{ }; + std::ifstream file{ vertexShaderPath }; + if (file.is_open()) { + ss << file.rdbuf(); + vertexShaderSource = ss.str(); + file.close(); + } + // Clear the stringstream and load the fragment shader source. + ss.str(std::string{ }); + file.open(fragmentShaderPath); + if (file.is_open()) { + ss << file.rdbuf(); + fragmentShaderSource = ss.str(); + file.close(); + } + // Create the program. + GLuint program = glCreateProgram(); + // Create the shaders. + GLuint vertexShader = glCreateShader(GL_VERTEX_SHADER); + GLuint fragmentShader = glCreateShader(GL_FRAGMENT_SHADER); + // Now we can load the shader source into the shader objects and compile them. + // Because glShaderSource() wants a const char* const*, + // we must first create a const char* and then pass the reference. + const char* cVertexSource = vertexShaderSource.c_str(); + glShaderSource(vertexShader, // shader + 1, // number of strings + &cVertexSource, // strings + nullptr); // length of strings (nullptr for 1) + glCompileShader(vertexShader); + // Now we have to do the same for the fragment shader. + const char* cFragmentSource = fragmentShaderSource.c_str(); + glShaderSource(fragmentShader, 1, &cFragmentSource, nullptr); + glCompileShader(fragmentShader); + // After attaching the source and compiling the shaders, + // we attach them to the program; + glAttachShader(program, vertexShader); + glAttachShader(program, fragmentShader); + glLinkProgram(program); + // After linking the shaders we should detach and delete + // them to prevent memory leak. + glDetachShader(program, vertexShader); + glDetachShader(program, fragmentShader); + glDeleteShader(vertexShader); + glDeleteShader(fragmentShader); + // With everything done we can return the completed program. + return program; +} +``` + +If you want to check the compilation log you can add the following between glCompileShader() and glAttachShader(). + +```cpp +GLint logSize = 0; +std::vector logText{ }; +glGetShaderiv(vertexShader, // shader + GL_INFO_LOG_LENGTH, // requested parameter + &logSize); // return object +if (logSize > 0) { + logText.resize(logSize); + glGetShaderInfoLog(vertexShader, // shader + logSize, // buffer length + &logSize, // returned length + logText.data()); // buffer + std::cout << logText.data() << std::endl; +} +``` + +The same is possible after glLinkProgram(), just replace glGetShaderiv() with glGetProgramiv() +and glGetShaderInfoLog() with glGetProgramInfoLog(). + +```cpp +// Now we can create a shader program with a vertex and a fragment shader. +// ... +glClearColor(0.0f, 0.0f, 0.0f, 1.0f); + +GLuint program = createShaderProgram("vertex.glsl", "fragment.glsl"); + +sf::Event event{ }; +// ... +// We also have to delete the program at the end of the application. +// ... + } + glDeleteProgram(program); + return 0; +} +// ... +``` + +Ofcourse we have to create the vertex and fragment shader before we can load them, +so lets create two basic shaders. + +**Vertex Shader** + +```glsl +// Declare which version of GLSL we use. +// Here we declare, that we want to use the OpenGL 3.3 version of GLSL. +#version 330 core +// At attribute location 0 we want an input variable of type vec3, +// that contains the position of the vertex. +// Setting the location is optional, if you don't set it you can ask for the +// location with glGetAttribLocation(). +layout(location = 0) in vec3 position; +// Every shader starts in it's main function. +void main() { + // gl_Position is a predefined variable that holds + // the final vertex position. + // It consists of a x, y, z and w coordinate. + gl_Position = vec4(position, 1.0); +} +``` + +**Fragment Shader** + +```glsl +#version 330 core +// The fragment shader does not have a predefined variable for +// the vertex color, so we have to define a output vec4, +// that holds the final vertex color. +out vec4 outColor; + +void main() { + // We simply set the output color to red. + // The parameters are red, green, blue and alpha. + outColor = vec4(1.0, 0.0, 0.0, 1.0); +} +``` + +## VAO and VBO +Now we need to define some vertex position we can pass to our shaders. Lets define a simple 2D quad. + +```cpp +// The vertex data is defined in a counter-clockwise way, +// as this is the default front face. +std::vector vertexData { + -0.5f, 0.5f, 0.0f, + -0.5f, -0.5f, 0.0f, + 0.5f, -0.5f, 0.0f, + 0.5f, 0.5f, 0.0f +}; +// If you want to use a clockwise definition, you can simply call +glFrontFace(GL_CW); +// Next we need to define a Vertex Array Object (VAO). +// The VAO stores the current state while its active. +GLuint vao = 0; +glGenVertexArrays(1, &vao); +glBindVertexArray(vao); +// With the VAO active we can now create a Vertex Buffer Object (VBO). +// The VBO stores our vertex data. +GLuint vbo = 0; +glGenBuffers(1, &vbo); +glBindBuffer(GL_ARRAY_BUFFER, vbo); +// For reading and copying there are also GL_*_READ and GL_*_COPY, +// if your data changes more often use GL_DYNAMIC_* or GL_STREAM_*. +glBufferData(GL_ARRAY_BUFFER, // target buffer + sizeof(vertexData[0]) * vertexData.size(), // size + vertexData.data(), // data + GL_STATIC_DRAW); // usage +// After filling the VBO link it to the location 0 in our vertex shader, +// which holds the vertex position. +// ... +// To ask for the attribute location, if you haven't set it: +GLint posLocation = glGetAttribLocation(program, "position"); +// .. +glEnableVertexAttribArray(0); +glVertexAttribPointer(0, 3, // location and size + GL_FLOAT, // type of data + GL_FALSE, // normalized (always false for floats) + 0, // stride (interleaved arrays) + nullptr); // offset (interleaved arrays) +// Everything should now be saved in our VAO and we can unbind it and the VBO. +glBindVertexArray(0); +glBindBuffer(GL_ARRAY_BUFFER, 0); +// Now we can draw the vertex data in our render loop. +// ... +glClear(GL_COLOR_BUFFER_BIT); +// Tell OpenGL we want to use our shader program. +glUseProgram(program); +// Binding the VAO loads the data we need. +glBindVertexArray(vao); +// We want to draw a quad starting at index 0 of the VBO using 4 indices. +glDrawArrays(GL_QUADS, 0, 4); +glBindVertexArray(0); +window.display(); +// ... +// Ofcource we have to delete the allocated memory for the VAO and VBO at +// the end of our application. +// ... +glDeleteBuffers(1, &vbo); +glDeleteVertexArrays(1, &vao); +glDeleteProgram(program); +return 0; +// ... +``` + +You can find the current code here: [OpenGL - 1](https://pastebin.com/W8jdmVHD). + +## More VBO's and Color +Let's create another VBO for some colors. + +```cpp +std::vector colorData { + 1.0f, 0.0f, 0.0f, + 0.0f, 1.0f, 0.0f, + 0.0f, 0.0f, 1.0f, + 1.0f, 1.0f, 0.0f +}; +``` + +Next we can simply change some previous parameters to create a second VBO for our colors. + +```cpp +// ... +GLuint vbo[2]; +glGenBuffers(2, vbo); +glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); +// ... +glDeleteBuffers(2, vbo); +/ ... +// With these changes made we now have to load our color data into the new VBO +// ... +glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 0, nullptr); + +glBindBuffer(GL_ARRAY_BUFFER, vbo[1]); +glBufferData(GL_ARRAY_BUFFER, sizeof(colorData[0]) * colorData.size(), + colorData.data(), GL_STATIC_DRAW); +glEnableVertexAttribArray(1); +glVertexAttribPointer(1, 3, GL_FLOAT, GL_FALSE, 0, nullptr); + +glBindVertexArray(0); +// ... +``` + +Next we have to change our vertex shader to pass the color data to the fragment shader.
+**Vertex Shader** + +```glsl +#version 330 core + +layout(location = 0) in vec3 position; +// The new location has to differ from any other input variable. +// It is the same index we need to pass to +// glEnableVertexAttribArray() and glVertexAttribPointer(). +layout(location = 1) in vec3 color; + +out vec3 fColor; + +void main() { + fColor = color; + gl_Position = vec4(position, 1.0); +} +``` + +**Fragment Shader** + +```glsl +#version 330 core + +in vec3 fColor; + +out vec4 outColor; + +void main() { + outColor = vec4(fColor, 1.0); +} +``` + +We define a new input variable ```color``` which represents our color data, this data +is passed on to ```fColor```, which is an output variable of our vertex shader and +becomes an input variable for our fragment shader. +It is imporatant that variables passed between shaders have the exact same name +and type. + +## Handling VBO's + +```cpp +// If you want to completely clear and refill a VBO use glBufferData(), +// just like we did before. +// ... +// There are two mains ways to update a subset of a VBO's data. +// To update a VBO with existing data +std::vector newSubData { + -0.25f, 0.5f, 0.0f +}; +glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); +glBufferSubData(GL_ARRAY_BUFFER, // target buffer + 0, // offset + sizeof(newSubData[0]) * newSubData.size(), // size + newSubData.data()); // data +// This would update the first three values in our vbo[0] buffer. +// If you want to update starting at a specific location just set the second +// parameter to that value and multiply by the types size. +// ... +// If you are streaming data, for example from a file, +// it is faster to directly pass the data to the buffer. +// Other access values are GL_READ_ONLY and GL_READ_WRITE. +glBindBuffer(GL_ARRAY_BUFFER, vbo[0]); +// You can static_cast() the void* to be more safe. +void* Ptr = glMapBuffer(GL_ARRAY_BUFFER, // buffer to map + GL_WRITE_ONLY); // access to buffer +memcpy(Ptr, newSubData.data(), sizeof(newSubData[0]) * newSubData.size()); +// To copy to a specific location add a destination offset to memcpy(). +glUnmapBuffer(GL_ARRAY_BUFFER); +// ... +// There is also a way to copy data from one buffer to another, +// If we have two VBO's vbo[0] and vbo[1], we can copy like so +// You can also read from GL_ARRAY_BUFFER. +glBindBuffer(GL_COPY_READ_BUFFER, vbo[0]); +// GL_COPY_READ_BUFFER and GL_COPY_WRITE_BUFFER are specifically for +// copying buffer data. +glBindBuffer(GL_COPY_WRITE_BUFFER, vbo[1]); +glCopyBufferSubData(GL_COPY_READ_BUFFER, // read buffer + GL_COPY_WRITE_BUFFER, // write buffer + 0, 0, // read and write offset + sizeof(vbo[0]) * 3); // copy size +// This will copy the first three elements from vbo[0] to vbo[1]. +``` + +## Uniforms + +**Fragment Shader** + +```glsl +// Uniforms are variables like in and out, however, +// we can change them easily by passing new values with glUniform(). +// Lets define a time variable in our fragment shader. +#version 330 core +// Unlike a in/out variable we can use a uniform in every shader, +// without the need to pass it to the next one, they are global. +// Don't use locations already used for attributes! +// Uniform layout locations require OpenGL 4.3! +layout(location = 10) uniform float time; + +in vec3 fColor; + +out vec4 outColor; + +void main() { + // Create a sine wave from 0 to 1 based on the time passed to the shader. + float factor = (sin(time * 2) + 1) / 2; + outColor = vec4(fColor.r * factor, fColor.g * factor, fColor.b * factor, 1.0); +} +``` + +Back to our source code. + +```cpp +// If we haven't set the layout location, we can ask for it. +GLint timeLocation = glGetUniformLocation(program, "time"); +// ... +// Also we should define a Timer counting the current time. +sf::Clock clock{ }; +// In out render loop we can now update the uniform every frame. + // ... + window.display(); + glUniform1f(10, // location + clock.getElapsedTime().asSeconds()); // data +} +// ... +``` + +With the time getting updated every frame the quad should now be changing from +fully colored to pitch black. +There are different types of glUniform() you can find simple documentation here: +[glUniform - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glUniform.xhtml) + +## Indexing and IBO's + +Element Array Buffers or more commonly Index Buffer Objects (IBO) allow us to use the +same vertex data again which makes drawing a lot easier and faster. here's an example: + +```cpp +// Lets create a quad from two rectangles. +// We can simply use the old vertex data from before. +// First, we have to create the IBO. +// The index is referring to the first declaration in the VBO. +std::vector iboData { + 0, 1, 2, + 0, 2, 3 +}; +// That's it, as you can see we could reuse 0 - the top left +// and 2 - the bottom right. +// Now that we have our data, we have to fill it into a buffer. +// Note that this has to happen between the two glBindVertexArray() calls, +// so it gets saved into the VAO. +GLuint ibo = 0; +glGenBufferrs(1, &ibo); +glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, ibo); +glBufferData(GL_ELEMENT_ARRAY_BUFFER, sizeof(iboData[0]) * iboData.size(), + iboData.data(), GL_STATIC_DRAW); +// Next in our render loop, we replace glDrawArrays() with: +glDrawElements(GL_TRIANGLES, iboData.size(), GL_UNSIGNED_INT, nullptr); +// Remember to delete the allocated memory for the IBO. +``` + +You can find the current code here: [OpenGL - 2](https://pastebin.com/R3Z9ACDE). + +## Textures + +To load out texture we first need a library that loads the data, for simplicity I will be +using SFML, however there are a lot of librarys for loading image data. + +```cpp +// Lets save we have a texture called "my_tex.tga", we can load it with: +sf::Image image; +image.loadFromFile("my_tex.tga"); +// We have to flip the texture around the y-Axis, because OpenGL's texture +// origin is the bottom left corner, not the top left. +image.flipVertically(); +// After loading it we have to create a OpenGL texture. +GLuint texture = 0; +glGenTextures(1, &texture); +glBindTexture(GL_TEXTURE_2D, texture); +// Specify what happens when the coordinates are out of range. +glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_REPEAT); +glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_REPEAT); +// Specify the filtering if the object is very large. +glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR); +glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR); +// Load the image data to the texture. +glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, image.getSize().x, image.getSize().y, + 0, GL_RGBA, GL_UNSIGNED_BYTE, image.getPixelsPtr()); +// Unbind the texture to prevent modifications. +glBindTexture(GL_TEXTURE_2D, 0); +// Delete the texture at the end of the application. +// ... +glDeleteTextures(1, &texture); +``` + +Ofcourse there are more texture formats than only 2D textures, +You can find further information on parameters here: +[glBindTexture - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glBindTexture.xhtml)
+[glTexImage2D - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glTexImage2D.xhtml)
+[glTexParameter - OpenGL Refpage](https://www.khronos.org/registry/OpenGL-Refpages/gl4/html/glTexParameter.xhtml)
+ +```cpp +// With the texture created, we now have to specify the UV, +// or in OpenGL terms ST coordinates. +std::vector texCoords { + // The texture coordinates have to match the triangles/quad + // definition. + 0.0f, 1.0f, // start at top-left + 0.0f, 0.0f, // go round counter-clockwise + 1.0f, 0.0f, + 1.0f, 1.0f // end at top-right +}; +// Now we increase the VBO's size again just like we did for the colors. +// ... +GLuint vbo[3]; +glGenBuffers(3, vbo); +// ... +glDeleteBuffers(3, vbo); +// ... +// Load the texture coordinates into the new buffer. +glBindBuffer(GL_ARRAY_BUFFER, vbo[2]); +glBufferData(GL_ARRAY_BUFFER, sizeof(texCoords[0]) * texCoords.size(), + texCoords.data(), GL_STATIC_DRAW); +glEnableVertexAttribArray(2); +glVertexAttribPointer(2, 2, GL_FLOAT, GL_FALSE, 0, nullptr); +// Because the VAO does not store the texture we have to bind it before drawing. +// ... +glBindVertexArray(vao); +glBindTexture(GL_TEXTURE_2D, texture); +glDrawElements(GL_TRIANGLES, iboData.size(), GL_UNSIGNED_INT, nullptr); +// ... +``` + +Change the shaders to pass the data to the fragment shader.
+ +**Vertex Shader** + +```glsl +#version 330 core + +layout(location = 0) in vec3 position; +layout(location = 1) in vec3 color; +layout(location = 2) in vec2 texCoords; + +out vec3 fColor; +out vec2 fTexCoords; + +void main() { + fColor = color; + fTexCoords = texCoords; + gl_Position = vec4(position, 1.0); +} +``` + +**Fragment Shader** + +```glsl +#version 330 core +// sampler2D represents our 2D texture. +uniform sampler2D tex; +uniform float time; + +in vec3 fColor; +in vec2 fTexCoords; + +out vec4 outColor; + +void main() { + // texture() loads the current texure data at the specified texture coords, + // then we can simply multiply them by our color. + outColor = texture(tex, fTexCoords) * vec4(fColor, 1.0); +} +``` + +You can find the current code here: [OpenGL - 3](https://pastebin.com/u3bcwM6q) + +## Matrix Transformation + +**Vertex Shader** + +```glsl +#version 330 core + +layout(location = 0) in vec3 position; +layout(location = 1) in vec3 color; +layout(location = 2) in vec2 texCoords; +// Create 2 4x4 matricies, 1 for the projection matrix +// and 1 for the model matrix. +// Because we draw in a static scene, we don't need a view matrix. +uniform mat4 projection; +uniform mat4 model; + +out vec3 fColor; +out vec2 fTexCoords; + +void main() { + fColor = color; + fTexCoords = texCoords; + // Multiplay the position by the model matrix and then by the + // projection matrix. + // Beware order of multiplication for matricies! + gl_Position = projection * model * vec4(position, 1.0); +} +``` + +In our source we now need to change the vertex data, create a model- and a projection matrix. + +```cpp +// The new vertex data, counter-clockwise declaration. +std::vector vertexData { + 0.0f, 1.0f, 0.0f, // top left + 0.0f, 0.0f, 0.0f, // bottom left + 1.0f, 0.0f, 0.0f, // bottom right + 1.0f, 1.0f, 0.0f // top right +}; +// Request the location of our matricies. +GLint projectionLocation = glGetUniformLocation(program, "projection"); +GLint modelLocation = glGetUniformLocation(program, "model"); +// Declaring the matricies. +// Orthogonal matrix for a 1024x768 window. +std::vector projection { + 0.001953f, 0.0f, 0.0f, 0.0f, + 0.0f, -0.002604f, 0.0f, 0.0f, + 0.0f, 0.0f, -1.0f, 0.0f, + -1.0f, 1.0f, 0.0f, 1.0f +}; +// Model matrix translating to x 50, y 50 +// and scaling to x 200, y 200. +std::vector model { + 200.0f, 0.0f, 0.0f, 0.0f, + 0.0f, 200.0f, 0.0f, 0.0f, + 0.0f, 0.0f, 1.0f, 0.0f, + 50.0f, 50.0f, 0.0f, 1.0f +}; +// Now we can send our calculated matricies to the program. +glUseProgram(program); +glUniformMatrix4fv(projectionLocation, // location + 1, // count + GL_FALSE, // transpose the matrix + projection.data()); // data +glUniformMatrix4fv(modelLocation, 1, GL_FALSE, model.data()); +glUseProgram(0); +// The glUniform*() calls have to be done, while the program is bound. +``` + +The application should now display the texture at the defined position and size.
+You can find the current code here: [OpenGL - 4](https://pastebin.com/9ahpFLkY) + +```cpp +// There are many math librarys for OpenGL, which create +// matricies and vectors, the most used in C++ is glm (OpenGL Mathematics). +// Its a header only library. +// The same code using glm would look like: +glm::mat4 projection{ glm::ortho(0.0f, 1024.0f, 768.0f, 0.0f) }; +glUniformMatrix4fv(projectionLocation, 1, GL_FALSE, + glm::value_ptr(projection)); +// Initialise the model matrix to the identity matrix, otherwise every +// multiplication would be 0. +glm::mat4 model{ 1.0f }; +model = glm::translate(model, glm::vec3{ 50.0f, 50.0f, 0.0f }); +model = glm::scale(model, glm::vec3{ 200.0f, 200.0f, 0.0f }); +glUniformMatrix4fv(modelLocation, 1, GL_FALSE, + glm::value_ptr(model)); +``` + +## Geometry Shader + +Geometry shaders were introduced in OpenGL 3.2, they can produce vertices +that are send to the rasterizer. They can also change the primitive type e.g. +they can take a point as an input and output other primitives. +Geometry shaders are inbetween the vertex and the fragment shader. + +**Vertex Shader** + +```glsl +#version 330 core + +layout(location = 0) in vec3 position; +layout(location = 1) in vec3 color; +// Create an output interface block passed to the next shadaer stage. +// Interface blocks can be used to structure data passed between shaders. +out VS_OUT { + vec3 color; +} vs_out; + +void main() { + vs_out.color = color + gl_Position = vec4(position, 1.0); +} +``` + +**Geometry Shader** + +```glsl +#version 330 core +// The geometry shader takes in points. +layout(points) in; +// It outputs a triangle every 3 vertices emitted. +layout(triangle_strip, max_vertices = 3) out; +// VS_OUT becomes an input variable in the geometry shader. +// Every input to the geometry shader in treated as an array. +in VS_OUT { + vec3 color; +} gs_in[]; +// Output color for the fragment shader. +// You can also simply define color as 'out vec3 color', +// If you don't want to use interface blocks. +out GS_OUT { + vec3 color; +} gs_out; + +void main() { + // Each emit calls the fragment shader, so we set a color for each vertex. + gs_out.color = mix(gs_in[0].color, vec3(1.0, 0.0, 0.0), 0.5); + // Move 0.5 units to the left and emit the new vertex. + // gl_in[] is the current vertex from the vertex shader, here we only + // use 0, because we are receiving points. + gl_Position = gl_in[0].gl_Position + vec4(-0.5, 0.0, 0.0, 0.0); + EmitVertex(); + gs_out.color = mix(gs_in[0].color, vec3(0.0, 1.0, 0.0), 0.5); + // Move 0.5 units to the right and emit the new vertex. + gl_Position = gl_in[0].gl_Position + vec4(0.5, 0.0, 0.0, 0.0); + EmitVertex(); + gs_out.color = mix(gs_in[0].color, vec3(0.0, 0.0, 1.0), 0.5); + // Move 0.5 units up and emit the new vertex. + gl_Position = gl_in[0].gl_Position + vec4(0.0, 0.75, 0.0, 0.0); + EmitVertex(); + EndPrimitive(); +} +``` + +**Fragment Shader** + +```glsl +in GS_OUT { + vec3 color; +} fs_in; + +out vec4 outColor; + +void main() { + outColor = vec4(fs_in.color, 1.0); +} +``` + +If you now store a single point with a single color in a VBO and draw them, +you should see a triangle, with your color mixed half way between +red, green and blue on each vertex. + + +## Quotes +[1][OpenGL - Wikipedia](https://en.wikipedia.org/wiki/OpenGL) + +## Books + +- OpenGL Superbible - Fifth Edition (covering OpenGL 3.3) +- OpenGL Programming Guide - Eighth Edition (covering OpenGL 4.3) diff --git a/pt-br/make-pt.html.markdown b/pt-br/make-pt.html.markdown index 40ac733a..d908435a 100644 --- a/pt-br/make-pt.html.markdown +++ b/pt-br/make-pt.html.markdown @@ -1,245 +1,245 @@ ---- -category: tool -tool: make -contributors: - - ["Robert Steed", "https://github.com/robochat"] - - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] -translators: - - ["Rogério Gomes Rio", "https://github.com/rogerlista"] -filename: Makefile-pt - -lang: pt-br ---- - -Um Makefile define um gráfico de regras para criar um alvo (ou alvos). Sua finalidade é fazer o mínimo de trabalho necessário para atualizar um alvo para a versão mais recente da fonte. Famosamente escrito ao longo de um fim de semana por Stuart Feldman em 1976, ainda é amplamente usada (particularmente no Unix e no Linux) apesar de muitos concorrentes e críticas. - -Existem muitas variedades de make na existência, no entanto, este artigo pressupõe que estamos usando o GNU make, que é o padrão no Linux. - -```make - -# Comentários podem ser escritos assim. - -# O arquivo deve ser nomeado Makefile e então pode ser executado como `make `. -# Caso contrário, nós usamos `make -f "nome-do-arquivo" `. - -# Aviso - use somente TABS para identar em Makefiles, nunca espaços! - -#----------------------------------------------------------------------- -# Noções básicas -#----------------------------------------------------------------------- - -# Regras são do formato -# alvo: -# onde os pré-requisitos são opcionais. - -# Uma regra - esta regra só será executada se o arquivo0.txt não existir. -arquivo0.txt: - echo "foo" > arquivo0.txt - # Mesmo os comentários nestas seções da 'receita' são passados ​​para o shell. - # Experimentar `make arquivo0.txt` or simplyou simplesmente `make` - primeira regra é o padrão. - -# Esta regra só será executada se arquivo0.txt for mais recente que arquivo1.txt. -arquivo1.txt: arquivo0.txt - cat arquivo0.txt > arquivo1.txt - # se as mesmas regras de citação do shell. - @cat arquivo0.txt >> arquivo1.txt - # @ pára o comando de ser ecoado para stdout. - -@echo 'hello' - # - significa que make continuará em caso de erro. - # Experimentar `make arquivo1.txt` na linha de comando. - -# Uma regra pode ter vários alvos e vários pré-requisitos -arquivo2.txt arquivo3.txt: arquivo0.txt arquivo1.txt - touch arquivo2.txt - touch arquivo3.txt - -# Make vai reclamar sobre várias receitas para a mesma regra. Esvaziar -# receitas não contam e podem ser usadas para adicionar novas dependências. - -#----------------------------------------------------------------------- -# Alvos falsos -#----------------------------------------------------------------------- - -# Um alvo falso. Qualquer alvo que não seja um arquivo. -# Ele nunca será atualizado, portanto, o make sempre tentará executá-lo. -all: maker process - -# Podemos declarar as coisas fora de ordem. -maker: - touch ex0.txt ex1.txt - -# Pode evitar quebrar regras falsas quando um arquivo real tem o mesmo nome -.PHONY: all maker process -# Este é um alvo especial. Existem vários outros. - -# Uma regra com dependência de um alvo falso sempre será executada -ex0.txt ex1.txt: maker - -# Alvos falsos comuns são: todos fazem instalação limpa ... - -#----------------------------------------------------------------------- -# Variáveis ​​Automáticas e Curingas -#----------------------------------------------------------------------- - -process: Arquivo*.txt # Usando um curinga para corresponder nomes de arquivos - @echo $^ # $^ é uma variável que contém a lista de pré-requisitos - @echo $@ # imprime o nome do alvo - #(fpara várias regras alvo, $@ é o que causou a execução da regra) - @echo $< # o primeiro pré-requisito listado - @echo $? # somente as dependências que estão desatualizadas - @echo $+ # todas as dependências, incluindo duplicadas (ao contrário do normal) - #@echo $| # todos os pré-requisitos 'somente pedidos' - -# Mesmo se dividirmos as definições de dependência de regra, $^ vai encontrá-los -process: ex1.txt arquivo0.txt -# ex1.txt será encontrado, mas arquivo0.txt será desduplicado. - -#----------------------------------------------------------------------- -# Padrões -#----------------------------------------------------------------------- - -# Pode ensinar make a converter certos arquivos em outros arquivos. - -%.png: %.svg - inkscape --export-png $^ - -# As regras padrões só farão qualquer coisa se decidirem criar o alvo. - -# Os caminhos de diretório são normalmente ignorados quando as regras de -# padrões são correspondentes. Mas make tentará usar a regra mais -# apropriada disponível. -small/%.png: %.svg - inkscape --export-png --export-dpi 30 $^ - -# make utilizará a última versão para uma regra de padrão que encontrar. -%.png: %.svg - @echo esta regra é escolhida - -# No entanto, o make usará a primeira regra padrão que pode se tornar o alvo -%.png: %.ps - @echo esta regra não é escolhida se *.svg and *.ps estão ambos presentes - -# make já tem algumas regras padrões embutidas. Por exemplo, ele sabe -# como transformar arquivos *.c em arquivos *.o. - -# Makefiles antigos podem usar regras de sufixo em vez de regras padrões -.png.ps: - @echo essa regra é semelhante a uma regra de padrão. - -# make sobre a regra de sufixo -.SUFFIXES: .png - -#----------------------------------------------------------------------- -# Variáveis -#----------------------------------------------------------------------- -# aka. macros - -# As variáveis ​​são basicamente todos os tipos de string - -name = Ted -name2="Sarah" - -echo: - @echo $(name) - @echo ${name2} - @echo $name # Isso não funcionará, tratado como $ (n)ame. - @echo $(name3) # Variáveis ​​desconhecidas são tratadas como strings vazias. - -# Existem 4 lugares para definir variáveis. -# Em ordem de prioridade, do maior para o menor: -# 1: argumentos de linha de comando -# 2: Makefile -# 3: variáveis ​​de ambiente do shell - faça importações automaticamente. -# 4: make tem algumas variáveis ​​predefinidas - -name4 ?= Jean -# Somente defina a variável se a variável de ambiente ainda não estiver definida. - -override name5 = David -# Pára os argumentos da linha de comando de alterar essa variável. - -name4 +=grey -# Anexar valores à variável (inclui um espaço). - -# Valores variáveis ​​específicos de padrões (extensão GNU). -echo: name2 = Sara # Verdadeiro dentro da regra de correspondência - # e também dentro de suas recursivas dependências - # (exceto que ele pode quebrar quando seu gráfico ficar muito complicado!) - -# Algumas variáveis ​​definidas automaticamente pelo make -echo_inbuilt: - echo $(CC) - echo ${CXX} - echo $(FC) - echo ${CFLAGS} - echo $(CPPFLAGS) - echo ${CXXFLAGS} - echo $(LDFLAGS) - echo ${LDLIBS} - -#----------------------------------------------------------------------- -# Variáveis 2 -#----------------------------------------------------------------------- - -# O primeiro tipo de variáveis ​​é avaliado a cada vez que elas são usadas. -# TIsso pode ser caro, então existe um segundo tipo de variável que é -# avaliado apenas uma vez. (Esta é uma extensão do GNU make) - -var := hello -var2 ::= $(var) hello -#:= e ::= são equivalentes. - -# Essas variáveis ​​são avaliadas procedimentalmente (na ordem em que -# aparecem), quebrando assim o resto da línguagem! - -# Isso não funciona -var3 ::= $(var4) and good luck -var4 ::= good night - -#----------------------------------------------------------------------- -# Funções -#----------------------------------------------------------------------- - -# make tem muitas funções disponíveis. - -sourcefiles = $(wildcard *.c */*.c) -objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) - -# O formato é $(func arg0,arg1,arg2...) - -# Alguns exemplos -ls: * src/* - @echo $(filter %.txt, $^) - @echo $(notdir $^) - @echo $(join $(dir $^),$(notdir $^)) - -#----------------------------------------------------------------------- -# Diretivas -#----------------------------------------------------------------------- - -# Inclua outros makefiles, úteis para código específico da plataforma -include foo.mk - -sport = tennis -# Compilação condicional -report: -ifeq ($(sport),tennis) - @echo 'game, set, match' -else - @echo "They think it's all over; it is now" -endif - -# Há também ifneq, ifdef, ifndef - -foo = true - -ifdef $(foo) -bar = 'hello' -endif -``` - -### More Resources - -+ [documentação gnu make](https://www.gnu.org/software/make/manual/) -+ [tutorial de carpintaria de software](http://swcarpentry.github.io/make-novice/) -+ aprenda C da maneira mais difícil [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) +--- +category: tool +tool: make +contributors: + - ["Robert Steed", "https://github.com/robochat"] + - ["Stephan Fuhrmann", "https://github.com/sfuhrm"] +translators: + - ["Rogério Gomes Rio", "https://github.com/rogerlista"] +filename: Makefile-pt + +lang: pt-br +--- + +Um Makefile define um gráfico de regras para criar um alvo (ou alvos). Sua finalidade é fazer o mínimo de trabalho necessário para atualizar um alvo para a versão mais recente da fonte. Famosamente escrito ao longo de um fim de semana por Stuart Feldman em 1976, ainda é amplamente usada (particularmente no Unix e no Linux) apesar de muitos concorrentes e críticas. + +Existem muitas variedades de make na existência, no entanto, este artigo pressupõe que estamos usando o GNU make, que é o padrão no Linux. + +```make + +# Comentários podem ser escritos assim. + +# O arquivo deve ser nomeado Makefile e então pode ser executado como `make `. +# Caso contrário, nós usamos `make -f "nome-do-arquivo" `. + +# Aviso - use somente TABS para identar em Makefiles, nunca espaços! + +#----------------------------------------------------------------------- +# Noções básicas +#----------------------------------------------------------------------- + +# Regras são do formato +# alvo: +# onde os pré-requisitos são opcionais. + +# Uma regra - esta regra só será executada se o arquivo0.txt não existir. +arquivo0.txt: + echo "foo" > arquivo0.txt + # Mesmo os comentários nestas seções da 'receita' são passados ​​para o shell. + # Experimentar `make arquivo0.txt` or simplyou simplesmente `make` - primeira regra é o padrão. + +# Esta regra só será executada se arquivo0.txt for mais recente que arquivo1.txt. +arquivo1.txt: arquivo0.txt + cat arquivo0.txt > arquivo1.txt + # se as mesmas regras de citação do shell. + @cat arquivo0.txt >> arquivo1.txt + # @ pára o comando de ser ecoado para stdout. + -@echo 'hello' + # - significa que make continuará em caso de erro. + # Experimentar `make arquivo1.txt` na linha de comando. + +# Uma regra pode ter vários alvos e vários pré-requisitos +arquivo2.txt arquivo3.txt: arquivo0.txt arquivo1.txt + touch arquivo2.txt + touch arquivo3.txt + +# Make vai reclamar sobre várias receitas para a mesma regra. Esvaziar +# receitas não contam e podem ser usadas para adicionar novas dependências. + +#----------------------------------------------------------------------- +# Alvos falsos +#----------------------------------------------------------------------- + +# Um alvo falso. Qualquer alvo que não seja um arquivo. +# Ele nunca será atualizado, portanto, o make sempre tentará executá-lo. +all: maker process + +# Podemos declarar as coisas fora de ordem. +maker: + touch ex0.txt ex1.txt + +# Pode evitar quebrar regras falsas quando um arquivo real tem o mesmo nome +.PHONY: all maker process +# Este é um alvo especial. Existem vários outros. + +# Uma regra com dependência de um alvo falso sempre será executada +ex0.txt ex1.txt: maker + +# Alvos falsos comuns são: todos fazem instalação limpa ... + +#----------------------------------------------------------------------- +# Variáveis ​​Automáticas e Curingas +#----------------------------------------------------------------------- + +process: Arquivo*.txt # Usando um curinga para corresponder nomes de arquivos + @echo $^ # $^ é uma variável que contém a lista de pré-requisitos + @echo $@ # imprime o nome do alvo + #(fpara várias regras alvo, $@ é o que causou a execução da regra) + @echo $< # o primeiro pré-requisito listado + @echo $? # somente as dependências que estão desatualizadas + @echo $+ # todas as dependências, incluindo duplicadas (ao contrário do normal) + #@echo $| # todos os pré-requisitos 'somente pedidos' + +# Mesmo se dividirmos as definições de dependência de regra, $^ vai encontrá-los +process: ex1.txt arquivo0.txt +# ex1.txt será encontrado, mas arquivo0.txt será desduplicado. + +#----------------------------------------------------------------------- +# Padrões +#----------------------------------------------------------------------- + +# Pode ensinar make a converter certos arquivos em outros arquivos. + +%.png: %.svg + inkscape --export-png $^ + +# As regras padrões só farão qualquer coisa se decidirem criar o alvo. + +# Os caminhos de diretório são normalmente ignorados quando as regras de +# padrões são correspondentes. Mas make tentará usar a regra mais +# apropriada disponível. +small/%.png: %.svg + inkscape --export-png --export-dpi 30 $^ + +# make utilizará a última versão para uma regra de padrão que encontrar. +%.png: %.svg + @echo esta regra é escolhida + +# No entanto, o make usará a primeira regra padrão que pode se tornar o alvo +%.png: %.ps + @echo esta regra não é escolhida se *.svg and *.ps estão ambos presentes + +# make já tem algumas regras padrões embutidas. Por exemplo, ele sabe +# como transformar arquivos *.c em arquivos *.o. + +# Makefiles antigos podem usar regras de sufixo em vez de regras padrões +.png.ps: + @echo essa regra é semelhante a uma regra de padrão. + +# make sobre a regra de sufixo +.SUFFIXES: .png + +#----------------------------------------------------------------------- +# Variáveis +#----------------------------------------------------------------------- +# aka. macros + +# As variáveis ​​são basicamente todos os tipos de string + +name = Ted +name2="Sarah" + +echo: + @echo $(name) + @echo ${name2} + @echo $name # Isso não funcionará, tratado como $ (n)ame. + @echo $(name3) # Variáveis ​​desconhecidas são tratadas como strings vazias. + +# Existem 4 lugares para definir variáveis. +# Em ordem de prioridade, do maior para o menor: +# 1: argumentos de linha de comando +# 2: Makefile +# 3: variáveis ​​de ambiente do shell - faça importações automaticamente. +# 4: make tem algumas variáveis ​​predefinidas + +name4 ?= Jean +# Somente defina a variável se a variável de ambiente ainda não estiver definida. + +override name5 = David +# Pára os argumentos da linha de comando de alterar essa variável. + +name4 +=grey +# Anexar valores à variável (inclui um espaço). + +# Valores variáveis ​​específicos de padrões (extensão GNU). +echo: name2 = Sara # Verdadeiro dentro da regra de correspondência + # e também dentro de suas recursivas dependências + # (exceto que ele pode quebrar quando seu gráfico ficar muito complicado!) + +# Algumas variáveis ​​definidas automaticamente pelo make +echo_inbuilt: + echo $(CC) + echo ${CXX} + echo $(FC) + echo ${CFLAGS} + echo $(CPPFLAGS) + echo ${CXXFLAGS} + echo $(LDFLAGS) + echo ${LDLIBS} + +#----------------------------------------------------------------------- +# Variáveis 2 +#----------------------------------------------------------------------- + +# O primeiro tipo de variáveis ​​é avaliado a cada vez que elas são usadas. +# TIsso pode ser caro, então existe um segundo tipo de variável que é +# avaliado apenas uma vez. (Esta é uma extensão do GNU make) + +var := hello +var2 ::= $(var) hello +#:= e ::= são equivalentes. + +# Essas variáveis ​​são avaliadas procedimentalmente (na ordem em que +# aparecem), quebrando assim o resto da línguagem! + +# Isso não funciona +var3 ::= $(var4) and good luck +var4 ::= good night + +#----------------------------------------------------------------------- +# Funções +#----------------------------------------------------------------------- + +# make tem muitas funções disponíveis. + +sourcefiles = $(wildcard *.c */*.c) +objectfiles = $(patsubst %.c,%.o,$(sourcefiles)) + +# O formato é $(func arg0,arg1,arg2...) + +# Alguns exemplos +ls: * src/* + @echo $(filter %.txt, $^) + @echo $(notdir $^) + @echo $(join $(dir $^),$(notdir $^)) + +#----------------------------------------------------------------------- +# Diretivas +#----------------------------------------------------------------------- + +# Inclua outros makefiles, úteis para código específico da plataforma +include foo.mk + +sport = tennis +# Compilação condicional +report: +ifeq ($(sport),tennis) + @echo 'game, set, match' +else + @echo "They think it's all over; it is now" +endif + +# Há também ifneq, ifdef, ifndef + +foo = true + +ifdef $(foo) +bar = 'hello' +endif +``` + +### More Resources + ++ [documentação gnu make](https://www.gnu.org/software/make/manual/) ++ [tutorial de carpintaria de software](http://swcarpentry.github.io/make-novice/) ++ aprenda C da maneira mais difícil [ex2](http://c.learncodethehardway.org/book/ex2.html) [ex28](http://c.learncodethehardway.org/book/ex28.html) diff --git a/ru-ru/asymptotic-notation-ru.html.markdown b/ru-ru/asymptotic-notation-ru.html.markdown index cb276ec1..02ebd205 100644 --- a/ru-ru/asymptotic-notation-ru.html.markdown +++ b/ru-ru/asymptotic-notation-ru.html.markdown @@ -1,225 +1,225 @@ ---- -category: Algorithms & Data Structures -name: Asymptotic Notation -contributors: - - ["Jake Prather", "http://github.com/JakeHP"] - - ["Divay Prakash", "http://github.com/divayprakash"] -translators: - - ["pru-mike", "http://github.com/pru-mike"] -lang: ru-ru ---- - -# О-символика - -## Что это такое? - -О-символика, или асимптотическая запись, — это система символов, позволяющая -оценить время выполнения алгоритма, устанавливая зависимость времени выполнения -от увеличения объёма входных данных. Она также известна как оценка -сложности алгоритмов. Станет ли алгоритм невероятно медленным, когда -объём входных данных увеличится? Будет ли алгоритм выполняться достаточно быстро, -если объём входных данных возрастёт? О-символика позволяет ответить на эти -вопросы. - -## Можно ли по-другому найти ответы на эти вопросы? - -Один способ — это подсчитать число элементарных операций в зависимости от -различных объёмов входных данных. Хотя это и приемлемое решение, тот объём -работы, которого оно потребует, даже для простых алгоритмов делает его -использование неоправданным. - -Другой способ — это измерить, какое время алгоритм потребует для завершения на -различных объёмах входных данных. В то же время, точность и относительность -этого метода (полученное время будет относиться только к той машине, на которой -оно вычислено) зависит от среды выполнения: компьютерного аппаратного -обеспечения, мощности процессора и т.д. - -## Виды О-символики - -В первом разделе этого документа мы определили, что О-символика -позволяет оценивать алгоритмы в зависимости от изменения размера входных -данных. Представим, что алгоритм — это функция f, n — размер входных данных и -f(n) — время выполнения. Тогда для данного алгоритма f с размером входных -данных n получим какое-то результирующее время выполнения f(n). -Из этого можно построить график, где ось y — время выполнения, ось x — размер входных -данных, а точки на графике — это время выполнения для заданного размера входных -данных. - -С помощью О-символики можно оценить функцию или алгоритм -несколькими различными способами. Например, можно оценить алгоритм исходя -из нижней оценки, верхней оценки, тождественной оценки. Чаще всего встречается -анализ на основе верхней оценки. Как правило, не используется нижняя оценка, -потому что она не подходит под планируемые условия. Отличный пример — алгоритмы -сортировки, особенно добавление элементов в древовидную структуру. Нижняя оценка -большинства таких алгоритмов может быть дана как одна операция. В то время как в -большинстве случаев добавляемые элементы должны быть отсортированы -соответствующим образом при помощи дерева, что может потребовать обхода целой -ветви. Это и есть худший случай, для которого планируется верхняя оценка. - -### Виды функций, пределы и упрощения - -``` -Логарифмическая функция — log n -Линейная функция — an + b -Квадратичная функция — an^2 + bn +c -Степенная функция — an^z + . . . + an^2 + a*n^1 + a*n^0, где z — константа -Показательная функция — a^n, где a — константа -``` - -Приведены несколько базовых функций, используемых при определении сложности в -различных оценках. Список начинается с самой медленно возрастающей функции -(логарифм, наиболее быстрое время выполнения) и следует до самой быстро -возрастающей функции (экспонента, самое медленное время выполнения). Отметим, -что в то время, как «n», или размер входных данных, возрастает в каждой из этих функций, -результат намного быстрее возрастает в квадратичной, степенной -и показательной по сравнению с логарифмической и линейной. - -Крайне важно понимать, что при использовании описанной далее нотации необходимо -использовать упрощённые выражения. -Это означает, что необходимо отбрасывать константы и слагаемые младших порядков, -потому что если размер входных данных (n в функции f(n) нашего примера) -увеличивается до бесконечности (в пределе), тогда слагаемые младших порядков -и константы становятся пренебрежительно малыми. Таким образом, если есть -константа, например, размера 2^9001 или любого другого невообразимого размера, -надо понимать, что её упрощение внесёт значительные искажения в точность -оценки. - -Т.к. нам нужны упрощённые выражения, немного скорректируем нашу таблицу... - -``` -Логарифм — log n -Линейная функция — n -Квадратичная функция — n^2 -Степенная функция — n^z, где z — константа -Показательная функция — a^n, где a — константа -``` - -### О Большое -О Большое, записывается как **О**, — это асимптотическая запись для оценки худшего -случая, или для ограничения заданной функции сверху. Это позволяет сделать -_**асимптотическую оценку верхней границы**_ скорости роста времени выполнения -алгоритма. Пусть `f(n)` — время выполнения алгоритма, а `g(n)` — заданная временная -сложность, которая проверяется для алгоритма. Тогда `f(n)` — это O(g(n)), если -существуют действительные константы c (c > 0) и n0, такие, -что `f(n)` <= `c g(n)` выполняется для всех n, начиная с некоторого n0 (n > n0). - -*Пример 1* - -``` -f(n) = 3log n + 100 -g(n) = log n -``` - -Является ли `f(n)` O(g(n))? -Является ли `3 log n + 100` O(log n)? -Посмотрим на определение О Большого: - -``` -3log n + 100 <= c * log n -``` - -Существуют ли константы c и n0, такие, что выражение верно для всех n > n0? - -``` -3log n + 100 <= 150 * log n, n > 2 (не определенно для n = 1) -``` - -Да! По определению О Большого `f(n)` является O(g(n)). - -*Пример 2* - -``` -f(n) = 3 * n^2 -g(n) = n -``` - -Является ли `f(n)` O(g(n))? -Является ли `3 * n^2` O(n)? -Посмотрим на определение О Большого: - -``` -3 * n^2 <= c * n -``` - -Существуют ли константы c и n0, такие, что выражение верно для всех n > n0? -Нет, не существуют. `f(n)` НЕ ЯВЛЯЕТСЯ O(g(n)). - -### Омега Большое -Омега Большое, записывается как **Ω**, — это асимптотическая запись для оценки -лучшего случая, или для ограничения заданной функции снизу. Это позволяет сделать -_**асимптотическую оценку нижней границы**_ скорости роста времени выполнения -алгоритма. - -`f(n)` является Ω(g(n)), если существуют действительные константы -c (c > 0) и n0 (n0 > 0), такие, что `f(n)` >= `c g(n)` для всех n > n0. - -### Примечание - -Асимптотические оценки, сделанные при помощи О Большого и Омега Большого, могут -как являться, так и не являться точными. Для того чтобы обозначить, что границы не -являются асимптотически точными, используются записи О Малое и Омега Малое. - -### О Малое -O Малое, записывается как **о**, — это асимптотическая запись для оценки верхней -границы времени выполнения алгоритма при условии, что граница не является -асимптотически точной. - -`f(n)` является o(g(n)), если можно подобрать такие действительные константы, -что для всех c (c > 0) найдётся n0 (n0 > 0), так -что `f(n)` < `c g(n)` выполняется для всех n (n > n0). - -Определения О-символики для О Большого и О Малого похожи. Главное отличие в том, -что если f(n) = O(g(n)), тогда условие f(n) <= c g(n) выполняется, если _**существует**_ -константа c > 0, но если f(n) = o(g(n)), тогда условие f(n) < c g(n) выполняется -для _**всех**_ констант c > 0. - -### Омега Малое -Омега Малое, записывается как **ω**, — это асимптотическая запись для оценки -верхней границы времени выполнения алгоритма при условии, что граница не является -асимптотически точной. - -`f(n)` является ω(g(n)), если можно подобрать такие действительные константы, -что для всех c (c > 0) найдётся n0 (n0 > 0), так -что `f(n)` > `c g(n)` выполняется для всех n (n > n0). - -Определения Ω-символики и ω-символики похожи. Главное отличие в том, что -если f(n) = Ω(g(n)), тогда условие f(n) >= c g(n) выполняется, если _**существует**_ -константа c > 0, но если f(n) = ω(g(n)), тогда условие f(n) > c g(n) -выполняется для _**всех**_ констант c > 0. - -### Тета -Тета, записывается как **Θ**, — это асимптотическая запись для оценки -_***асимптотически точной границы***_ времени выполнения алгоритма. - -`f(n)` является Θ(g(n)), если для некоторых действительных -констант c1, c2 и n0 (c1 > 0, c2 > 0, n0 > 0) -`c1 g(n)` < `f(n)` < `c2 g(n)` для всех n (n > n0). - -∴ `f(n)` является Θ(g(n)) означает, что `f(n)` является O(g(n)) -и `f(n)` является Ω(g(n)). - -О Большое — основной инструмент для анализа сложности алгоритмов. -Также см. примеры по ссылкам. - -### Заключение -Такую тему сложно изложить кратко, поэтому обязательно стоит пройти по ссылкам и -посмотреть дополнительную литературу. В ней даётся более глубокое описание с -определениями и примерами. - - -## Дополнительная литература - -* [Алгоритмы на Java](https://www.ozon.ru/context/detail/id/18319699/) -* [Алгоритмы. Построение и анализ](https://www.ozon.ru/context/detail/id/33769775/) - -## Ссылки - -* [Оценки времени исполнения. Символ O()](http://algolist.manual.ru/misc/o_n.php) -* [Асимптотический анализ и теория вероятностей](https://www.lektorium.tv/course/22903) - -## Ссылки (англ.) - -* [Algorithms, Part I](https://www.coursera.org/learn/algorithms-part1) -* [Cheatsheet 1](http://web.mit.edu/broder/Public/asymptotics-cheatsheet.pdf) -* [Cheatsheet 2](http://bigocheatsheet.com/) - +--- +category: Algorithms & Data Structures +name: Asymptotic Notation +contributors: + - ["Jake Prather", "http://github.com/JakeHP"] + - ["Divay Prakash", "http://github.com/divayprakash"] +translators: + - ["pru-mike", "http://github.com/pru-mike"] +lang: ru-ru +--- + +# О-символика + +## Что это такое? + +О-символика, или асимптотическая запись, — это система символов, позволяющая +оценить время выполнения алгоритма, устанавливая зависимость времени выполнения +от увеличения объёма входных данных. Она также известна как оценка +сложности алгоритмов. Станет ли алгоритм невероятно медленным, когда +объём входных данных увеличится? Будет ли алгоритм выполняться достаточно быстро, +если объём входных данных возрастёт? О-символика позволяет ответить на эти +вопросы. + +## Можно ли по-другому найти ответы на эти вопросы? + +Один способ — это подсчитать число элементарных операций в зависимости от +различных объёмов входных данных. Хотя это и приемлемое решение, тот объём +работы, которого оно потребует, даже для простых алгоритмов делает его +использование неоправданным. + +Другой способ — это измерить, какое время алгоритм потребует для завершения на +различных объёмах входных данных. В то же время, точность и относительность +этого метода (полученное время будет относиться только к той машине, на которой +оно вычислено) зависит от среды выполнения: компьютерного аппаратного +обеспечения, мощности процессора и т.д. + +## Виды О-символики + +В первом разделе этого документа мы определили, что О-символика +позволяет оценивать алгоритмы в зависимости от изменения размера входных +данных. Представим, что алгоритм — это функция f, n — размер входных данных и +f(n) — время выполнения. Тогда для данного алгоритма f с размером входных +данных n получим какое-то результирующее время выполнения f(n). +Из этого можно построить график, где ось y — время выполнения, ось x — размер входных +данных, а точки на графике — это время выполнения для заданного размера входных +данных. + +С помощью О-символики можно оценить функцию или алгоритм +несколькими различными способами. Например, можно оценить алгоритм исходя +из нижней оценки, верхней оценки, тождественной оценки. Чаще всего встречается +анализ на основе верхней оценки. Как правило, не используется нижняя оценка, +потому что она не подходит под планируемые условия. Отличный пример — алгоритмы +сортировки, особенно добавление элементов в древовидную структуру. Нижняя оценка +большинства таких алгоритмов может быть дана как одна операция. В то время как в +большинстве случаев добавляемые элементы должны быть отсортированы +соответствующим образом при помощи дерева, что может потребовать обхода целой +ветви. Это и есть худший случай, для которого планируется верхняя оценка. + +### Виды функций, пределы и упрощения + +``` +Логарифмическая функция — log n +Линейная функция — an + b +Квадратичная функция — an^2 + bn +c +Степенная функция — an^z + . . . + an^2 + a*n^1 + a*n^0, где z — константа +Показательная функция — a^n, где a — константа +``` + +Приведены несколько базовых функций, используемых при определении сложности в +различных оценках. Список начинается с самой медленно возрастающей функции +(логарифм, наиболее быстрое время выполнения) и следует до самой быстро +возрастающей функции (экспонента, самое медленное время выполнения). Отметим, +что в то время, как «n», или размер входных данных, возрастает в каждой из этих функций, +результат намного быстрее возрастает в квадратичной, степенной +и показательной по сравнению с логарифмической и линейной. + +Крайне важно понимать, что при использовании описанной далее нотации необходимо +использовать упрощённые выражения. +Это означает, что необходимо отбрасывать константы и слагаемые младших порядков, +потому что если размер входных данных (n в функции f(n) нашего примера) +увеличивается до бесконечности (в пределе), тогда слагаемые младших порядков +и константы становятся пренебрежительно малыми. Таким образом, если есть +константа, например, размера 2^9001 или любого другого невообразимого размера, +надо понимать, что её упрощение внесёт значительные искажения в точность +оценки. + +Т.к. нам нужны упрощённые выражения, немного скорректируем нашу таблицу... + +``` +Логарифм — log n +Линейная функция — n +Квадратичная функция — n^2 +Степенная функция — n^z, где z — константа +Показательная функция — a^n, где a — константа +``` + +### О Большое +О Большое, записывается как **О**, — это асимптотическая запись для оценки худшего +случая, или для ограничения заданной функции сверху. Это позволяет сделать +_**асимптотическую оценку верхней границы**_ скорости роста времени выполнения +алгоритма. Пусть `f(n)` — время выполнения алгоритма, а `g(n)` — заданная временная +сложность, которая проверяется для алгоритма. Тогда `f(n)` — это O(g(n)), если +существуют действительные константы c (c > 0) и n0, такие, +что `f(n)` <= `c g(n)` выполняется для всех n, начиная с некоторого n0 (n > n0). + +*Пример 1* + +``` +f(n) = 3log n + 100 +g(n) = log n +``` + +Является ли `f(n)` O(g(n))? +Является ли `3 log n + 100` O(log n)? +Посмотрим на определение О Большого: + +``` +3log n + 100 <= c * log n +``` + +Существуют ли константы c и n0, такие, что выражение верно для всех n > n0? + +``` +3log n + 100 <= 150 * log n, n > 2 (не определенно для n = 1) +``` + +Да! По определению О Большого `f(n)` является O(g(n)). + +*Пример 2* + +``` +f(n) = 3 * n^2 +g(n) = n +``` + +Является ли `f(n)` O(g(n))? +Является ли `3 * n^2` O(n)? +Посмотрим на определение О Большого: + +``` +3 * n^2 <= c * n +``` + +Существуют ли константы c и n0, такие, что выражение верно для всех n > n0? +Нет, не существуют. `f(n)` НЕ ЯВЛЯЕТСЯ O(g(n)). + +### Омега Большое +Омега Большое, записывается как **Ω**, — это асимптотическая запись для оценки +лучшего случая, или для ограничения заданной функции снизу. Это позволяет сделать +_**асимптотическую оценку нижней границы**_ скорости роста времени выполнения +алгоритма. + +`f(n)` является Ω(g(n)), если существуют действительные константы +c (c > 0) и n0 (n0 > 0), такие, что `f(n)` >= `c g(n)` для всех n > n0. + +### Примечание + +Асимптотические оценки, сделанные при помощи О Большого и Омега Большого, могут +как являться, так и не являться точными. Для того чтобы обозначить, что границы не +являются асимптотически точными, используются записи О Малое и Омега Малое. + +### О Малое +O Малое, записывается как **о**, — это асимптотическая запись для оценки верхней +границы времени выполнения алгоритма при условии, что граница не является +асимптотически точной. + +`f(n)` является o(g(n)), если можно подобрать такие действительные константы, +что для всех c (c > 0) найдётся n0 (n0 > 0), так +что `f(n)` < `c g(n)` выполняется для всех n (n > n0). + +Определения О-символики для О Большого и О Малого похожи. Главное отличие в том, +что если f(n) = O(g(n)), тогда условие f(n) <= c g(n) выполняется, если _**существует**_ +константа c > 0, но если f(n) = o(g(n)), тогда условие f(n) < c g(n) выполняется +для _**всех**_ констант c > 0. + +### Омега Малое +Омега Малое, записывается как **ω**, — это асимптотическая запись для оценки +верхней границы времени выполнения алгоритма при условии, что граница не является +асимптотически точной. + +`f(n)` является ω(g(n)), если можно подобрать такие действительные константы, +что для всех c (c > 0) найдётся n0 (n0 > 0), так +что `f(n)` > `c g(n)` выполняется для всех n (n > n0). + +Определения Ω-символики и ω-символики похожи. Главное отличие в том, что +если f(n) = Ω(g(n)), тогда условие f(n) >= c g(n) выполняется, если _**существует**_ +константа c > 0, но если f(n) = ω(g(n)), тогда условие f(n) > c g(n) +выполняется для _**всех**_ констант c > 0. + +### Тета +Тета, записывается как **Θ**, — это асимптотическая запись для оценки +_***асимптотически точной границы***_ времени выполнения алгоритма. + +`f(n)` является Θ(g(n)), если для некоторых действительных +констант c1, c2 и n0 (c1 > 0, c2 > 0, n0 > 0) +`c1 g(n)` < `f(n)` < `c2 g(n)` для всех n (n > n0). + +∴ `f(n)` является Θ(g(n)) означает, что `f(n)` является O(g(n)) +и `f(n)` является Ω(g(n)). + +О Большое — основной инструмент для анализа сложности алгоритмов. +Также см. примеры по ссылкам. + +### Заключение +Такую тему сложно изложить кратко, поэтому обязательно стоит пройти по ссылкам и +посмотреть дополнительную литературу. В ней даётся более глубокое описание с +определениями и примерами. + + +## Дополнительная литература + +* [Алгоритмы на Java](https://www.ozon.ru/context/detail/id/18319699/) +* [Алгоритмы. Построение и анализ](https://www.ozon.ru/context/detail/id/33769775/) + +## Ссылки + +* [Оценки времени исполнения. Символ O()](http://algolist.manual.ru/misc/o_n.php) +* [Асимптотический анализ и теория вероятностей](https://www.lektorium.tv/course/22903) + +## Ссылки (англ.) + +* [Algorithms, Part I](https://www.coursera.org/learn/algorithms-part1) +* [Cheatsheet 1](http://web.mit.edu/broder/Public/asymptotics-cheatsheet.pdf) +* [Cheatsheet 2](http://bigocheatsheet.com/) + diff --git a/tr-tr/sql-tr.html.markdown b/tr-tr/sql-tr.html.markdown index 54007d32..2e91e9f8 100644 --- a/tr-tr/sql-tr.html.markdown +++ b/tr-tr/sql-tr.html.markdown @@ -1,125 +1,125 @@ ---- -language: SQL -contributors: - - ["Metin Yalçınkaya", "https://github.com/mtnylnky"] -lang: tr-tr -filename: learnsql-tr.sql ---- - - -```sql --- Yorumlar iki tire ile başlar - --- KISITLAR -Not null -- Bir kolon asla boş olamaz -default -- Boş olan yerlere varsayılan bir değer atar -unique -- Bir kolondaki tüm değerlerin farklı olması kısıtlaması -primary key -- Bir tablodaki her veri için kimlik bilgisi niteliğindedir -check -- Bir kolondaki değerlerin belli bir kısıtlamayı sağlamasını sağlar - --- Tablo oluşturulur -CREATE TABLE tablo1 (); - --- Tabloyu içerisinde kolonlar ile oluşturma -CREATE TABLE tablo1(id INTEGER PRIMARY KEY NOT NULL UNIQUE, ad TEXT, soyad TEXT, yas INTEGER); - --- TABLO varlığını kontrol eder -.table - --- Veri tabanında olan bütün tabloları görüntüler. -.schema - --- Satır ekle -INSERT INTO tablo1 ( ad, soyad) VALUES ("Deger1","Deger2"); - --- Veritabanında tablo üzerindeki verileri görüntüle --- Sadece 'ad' gibi sınırlı bir veri için -SELECT ad FROM tablo1; --- Bütün veriler için -SELECT * FROM tablo1; - --- Veri güncelleme -UPDATE tablo1 SET ad = "deger1-2"; WHERE name = "Deger1"; - --- Satır sil -DELETE FROM tablo1 WHERE id = 1; -DELETE FROM tablo1 WHERE ad = "Deger1" OR ad = "Deger2"; - --- Tabloya sonradan kolon ekleme -ALTER TABLE tablo1 ADD COLUMN email TEXT; - --- Tablodaki kolon adı değiştirme -EXEC sp_rename ' tablo1.[ad]', Ad, 'COLUMN'; - --- Tablo adı değiştirme -ALTER TABLE table1 RENAME TO Table1; - --- Tabloyu silme -DROP TABLE Table1; - --- BİR TABLOYU BAŞKA TABLO KULLANARAK DOLDURMAK -INSERT INTO Tablo2 SELECT id,ad, soyad, email from Tablo1; - --- LIKE KOMUTU --- Belirli bir kritere göre arama yaparken kullanılır --- Adı 'A' ile başlayan veriler -SELECT * FROM tablo1 WHERE adi LIKE "A%"; --- İçinde 'A' olan veriler -SELECT * FROM tablo1 WHERE adi LIKE "%A%"; - --- LIMIT KOMUTU --- Gösterilen satır sayısını sınırlamak için -SELECT * FROM Tablo1 LIMIT 6; --- Gösterilen satırları belirli bir noktadan başlamak üzere sınırlamak için -SELECT * FROM Tablo1 LIMIT 6 OFFSET 3; - --- ORDER BY KOMUTU --- Herhangi bir kolona göre gösterilen değerleri azalan veya artan şekilde sıralamak için -SELECT kolon FROM tablo1 WHERE yas ORDER BY column1, column2, .. columnN] [ASC | DESC]; -SELECT * FROM Tablo1 ORDER BY yas ASC -SELECT * FROM Tablo1 ORDER BY yas DESC - --- DISTINCT ANAHTAR SÖZCÜĞÜ --- Bu anahtar sözcükle sadece farklı değerler gösterilir. -SELECT DISTINCT yas FROM tablo1; - --- JOIN KOMUTU --- CROSS JOIN --- Cross join bir tablodaki her satırı ikinci tablodaki bir satır ile eşleştirmek için kulanılır. --- Eğer birinci tabloda x satır ikinci tabloda y satır varsa sonuçta x*y satır olur. -SELECT ... FROM table1 CROSS JOIN table2 … -SELECT ad, yas FROM Tablo1 CROSS JOIN Tablo2; - --- INNER JOIN --- Inner join iki tablodaki ortak kolon değerlerini kullanarak bir sonuç üretir. -SELECT ... FROM table1 [INNER] JOIN table2 ON conditional_expression … -SELECT ad, yas FROM Tablo1 INNER JOIN Tablo2 ON Tablo1.ad = Tablo2.soyad; - --- OUTER JOIN --- Outer join iki tablodaki ortak kolon değerlerinin dışında kalanları kullanarak bir sonuç üretir. -SELECT isci_num, isim, dept FROM Tablo1 LEFT OUTER JOIN Tablo2 ON Tablo1.id = Tablo2.isci_num; - --- ÇEKİRDEK FONKSİYONLAR -COUNT -- Sayma -AVG -- Ortalama -ABS -- Mutlak değer -SUM -- Toplam -RANDOM -- Rastgele -ROUND -- Yuvarlama -MAX -- Maksimim -MIN -- Minimum -UPPER -- Büyük Harf -LOWER -- Küçük Harf -LENGTH -- Uzunluk -CURRENT_TIMESTAMP -- Zaman - -SELECT max(yas) FROM Table1; -SELECT min(yas) FROM Table1; -SELECT avg(yas) FROM Table1; -SELECT * From Table1 WHERE yas ==18; -SELECT sum(yas) FROM Table1; -SELECT random() AS Random; -SELECT upper(ad) FROM Table1; -SELECT lower(ad) FROM Table1; -SELECT ad, length(ad) FROM Table1; +--- +language: SQL +contributors: + - ["Metin Yalçınkaya", "https://github.com/mtnylnky"] +lang: tr-tr +filename: learnsql-tr.sql +--- + + +```sql +-- Yorumlar iki tire ile başlar + +-- KISITLAR +Not null -- Bir kolon asla boş olamaz +default -- Boş olan yerlere varsayılan bir değer atar +unique -- Bir kolondaki tüm değerlerin farklı olması kısıtlaması +primary key -- Bir tablodaki her veri için kimlik bilgisi niteliğindedir +check -- Bir kolondaki değerlerin belli bir kısıtlamayı sağlamasını sağlar + +-- Tablo oluşturulur +CREATE TABLE tablo1 (); + +-- Tabloyu içerisinde kolonlar ile oluşturma +CREATE TABLE tablo1(id INTEGER PRIMARY KEY NOT NULL UNIQUE, ad TEXT, soyad TEXT, yas INTEGER); + +-- TABLO varlığını kontrol eder +.table + +-- Veri tabanında olan bütün tabloları görüntüler. +.schema + +-- Satır ekle +INSERT INTO tablo1 ( ad, soyad) VALUES ("Deger1","Deger2"); + +-- Veritabanında tablo üzerindeki verileri görüntüle +-- Sadece 'ad' gibi sınırlı bir veri için +SELECT ad FROM tablo1; +-- Bütün veriler için +SELECT * FROM tablo1; + +-- Veri güncelleme +UPDATE tablo1 SET ad = "deger1-2"; WHERE name = "Deger1"; + +-- Satır sil +DELETE FROM tablo1 WHERE id = 1; +DELETE FROM tablo1 WHERE ad = "Deger1" OR ad = "Deger2"; + +-- Tabloya sonradan kolon ekleme +ALTER TABLE tablo1 ADD COLUMN email TEXT; + +-- Tablodaki kolon adı değiştirme +EXEC sp_rename ' tablo1.[ad]', Ad, 'COLUMN'; + +-- Tablo adı değiştirme +ALTER TABLE table1 RENAME TO Table1; + +-- Tabloyu silme +DROP TABLE Table1; + +-- BİR TABLOYU BAŞKA TABLO KULLANARAK DOLDURMAK +INSERT INTO Tablo2 SELECT id,ad, soyad, email from Tablo1; + +-- LIKE KOMUTU +-- Belirli bir kritere göre arama yaparken kullanılır +-- Adı 'A' ile başlayan veriler +SELECT * FROM tablo1 WHERE adi LIKE "A%"; +-- İçinde 'A' olan veriler +SELECT * FROM tablo1 WHERE adi LIKE "%A%"; + +-- LIMIT KOMUTU +-- Gösterilen satır sayısını sınırlamak için +SELECT * FROM Tablo1 LIMIT 6; +-- Gösterilen satırları belirli bir noktadan başlamak üzere sınırlamak için +SELECT * FROM Tablo1 LIMIT 6 OFFSET 3; + +-- ORDER BY KOMUTU +-- Herhangi bir kolona göre gösterilen değerleri azalan veya artan şekilde sıralamak için +SELECT kolon FROM tablo1 WHERE yas ORDER BY column1, column2, .. columnN] [ASC | DESC]; +SELECT * FROM Tablo1 ORDER BY yas ASC +SELECT * FROM Tablo1 ORDER BY yas DESC + +-- DISTINCT ANAHTAR SÖZCÜĞÜ +-- Bu anahtar sözcükle sadece farklı değerler gösterilir. +SELECT DISTINCT yas FROM tablo1; + +-- JOIN KOMUTU +-- CROSS JOIN +-- Cross join bir tablodaki her satırı ikinci tablodaki bir satır ile eşleştirmek için kulanılır. +-- Eğer birinci tabloda x satır ikinci tabloda y satır varsa sonuçta x*y satır olur. +SELECT ... FROM table1 CROSS JOIN table2 … +SELECT ad, yas FROM Tablo1 CROSS JOIN Tablo2; + +-- INNER JOIN +-- Inner join iki tablodaki ortak kolon değerlerini kullanarak bir sonuç üretir. +SELECT ... FROM table1 [INNER] JOIN table2 ON conditional_expression … +SELECT ad, yas FROM Tablo1 INNER JOIN Tablo2 ON Tablo1.ad = Tablo2.soyad; + +-- OUTER JOIN +-- Outer join iki tablodaki ortak kolon değerlerinin dışında kalanları kullanarak bir sonuç üretir. +SELECT isci_num, isim, dept FROM Tablo1 LEFT OUTER JOIN Tablo2 ON Tablo1.id = Tablo2.isci_num; + +-- ÇEKİRDEK FONKSİYONLAR +COUNT -- Sayma +AVG -- Ortalama +ABS -- Mutlak değer +SUM -- Toplam +RANDOM -- Rastgele +ROUND -- Yuvarlama +MAX -- Maksimim +MIN -- Minimum +UPPER -- Büyük Harf +LOWER -- Küçük Harf +LENGTH -- Uzunluk +CURRENT_TIMESTAMP -- Zaman + +SELECT max(yas) FROM Table1; +SELECT min(yas) FROM Table1; +SELECT avg(yas) FROM Table1; +SELECT * From Table1 WHERE yas ==18; +SELECT sum(yas) FROM Table1; +SELECT random() AS Random; +SELECT upper(ad) FROM Table1; +SELECT lower(ad) FROM Table1; +SELECT ad, length(ad) FROM Table1; ``` \ No newline at end of file diff --git a/vi-vn/git-vi.html.markdown b/vi-vn/git-vi.html.markdown index f5454ebf..47485bd9 100644 --- a/vi-vn/git-vi.html.markdown +++ b/vi-vn/git-vi.html.markdown @@ -1,328 +1,328 @@ ---- -category: tool -tool: git -contributors: +--- +category: tool +tool: git +contributors: - ["Jake Prather", "http://github.com/JakeHP"] - - ["Vinh Nguyen", "https://twitter.com/vinhnx"] -filename: LearnGit-vi.txt -lang: vi-vn ---- - -Git là một hệ quản lý mã nguồn và phiên bản phân tán (distributed version control and source code management system). - -Nó làm được điều này là do một loạt các snapshot từ đề án của bạn, và nó hoạt động -với các snapshot đó để cung cấp cho bạn với chức năng đến phiên bản và -quản lý mã nguồn của bạn. - -## Khái Niệm Versioning - -### Version Control là gì? - -Version Control là một hệ thống ghi lại những thay đổi ở một tập tin, hay một nhóm các tập tin, theo thời gian. - -### So sánh giữa Centralized Versioning và Distributed Versioning - -* Quản lý phiên bản tập trung (Centralized Versioning) tập trung vào việc đồng bộ hóa, theo dõi, và lưu trữ tập tin. -* Quản lý phiên bản phân tán (Distributed Versioning) tập trung vào việc chia sẻ các thay đổi. Mỗi sự thay đổi có một mã định dạng (id) duy nhất. -* Các hệ phân tán không có cấu trúc định sẵn. Bạn có thể thay đổi một kiểu SVN, hệ phân tán, với git. - -[Thông tin thêm](http://git-scm.com/book/en/Getting-Started-About-Version-Control) - -### Tại Sao Dùng Git? - -* Có thể hoạt động offline. -* Cộng tác với nhau rất dễ dàng! -* Phân nhánh dễ dàng! -* Trộn (Merging) -* Git nhanh. -* Git linh hoạt. - -## Kiến Trúc Git - - -### Repository - -Một nhóm các tập tin, thư mục, các ghi chép trong quá khứ, commit, và heads. Tưởng tượng nó như là một cấu trúc dữ liệu mã nguồn, -với thuộc tính mà một "nhân tố" mã nguồn cho bạn quyền truy cập đến lịch sử sửa đổi, và một số thứ khác. - -Một git repository bao gồm thư mục .git & tree đang làm việc. - -### Thư mục .git (thành phần của một repository) - -Thư mục .git chứa tất cả các cấu hình, log, nhánh, HEAD, và hơn nữa. -[Danh Sách Chi Tiết.](http://gitready.com/advanced/2009/03/23/whats-inside-your-git-directory.html) - -### Tree Đang Làm (thành phần của một repository) - -Đây cơ bản là các thư mục và tập tin trong repository của bạn. Nó thường được tham chiếu -thư mục đang làm việc của bạn - -### Chỉ mục (thành phần của một thư mục .git) - -Chỉ mục của là một staging area trong git. Nó đơn giản là một lớp riêng biệt với tree đang làm việc của bạn -từ Git repository. Điều này cho nhà phát triền nhiều lựa chọn hơn trong việc xem xét những gì được gửi đến Git -repository. - -### Commit - -Một git commit là một snapshot của một nhóm các thay đổi, hoặc các thao tác Working Tree của bạn. -Ví dụ, nếu bạn thêm 5 tập tin, và xóa 2 tập tin khác, những thay đổi này sẽ được chứa trong -một commit (hoặc snapshot). Commit này có thể được đẩy đến các repo khác, hoặc không! - -### Nhánh - -Nhánh thực chất là một con trỏ đến commit mới nhất mà bạn vừa thực hiện. Khi bạn commit, -con trỏ này sẽ cập nhật tự động và trỏ đến commit mới nhất. - -### HEAD và head (thành phần của thư mục .git) - -HEAD là một con trỏ đến branch hiện tại. Một repo chỉ có một HEAD *đang hoạt động*. -head là một con trỏ đến bất kỳ commit nào. Một repo có thể có nhiều head. - -### Các Tài Nguyên Mang Tính Khái Niệm - -* [Git For Computer Scientists](http://eagain.net/articles/git-for-computer-scientists/) -* [Git For Designers](http://hoth.entp.com/output/git_for_designers.html) - - -## Các Lệnh - - -### init - -Tạo một repo Git rỗng. Các cài đặt, thông tin lưu trữ... của Git -được lưu ở một thư mục tên là ".git". - -```bash -$ git init -``` - -### config - -Để chỉnh tùy chọn. Bất kể là cho repo, hay cho hệ thống, hay điều chỉnh -toàn cục (global) - - - -```bash -# In Ra & Và Gán Một Số Biến Tùy Chỉnh Cơ Bản (Toàn cục - Global) -$ git config --global user.email -$ git config --global user.name - -$ git config --global user.email "MyEmail@Zoho.com" -$ git config --global user.name "My Name" -``` - -[Tìm hiểu thêm về git config.](http://git-scm.com/docs/git-config) - -### help - -Để cho bạn lối truy cập nhanh đến một chỉ dẫn cực kỳ chi tiết của từng lệnh. Hoặc chỉ để -nhắc bạn một số cú pháp. - -```bash -# Xem nhanh các lệnh có sẵn -$ git help - -# Xem tất các các lệnh -$ git help -a - -# Lệnh help riêng biệt - tài liệu người dùng -# git help -$ git help add -$ git help commit -$ git help init -``` - -### status - -Để hiển thị sự khác nhau giữa tập tin index (cơ bản là repo đang làm việc) và HEAD commit -hiện tại. - - -```bash -# Sẽ hiển thị nhánh, các tập tin chưa track (chưa commit), các thay đổi và những khác biệt khác -$ git status - -# Để xem các "tid bits" về git status -$ git help status -``` - -### add - -Để thêm các tập vào tree/thư mục/repo hiện tại. Nếu bạn không `git add` các tập tin mới đến -tree/thư mục hiện tại, chúng sẽ không được kèm theo trong các commit! - -```bash -# thêm một file vào thư mục hiện tại -$ git add HelloWorld.java - -# thêm một file vào một thư mục khác -$ git add /path/to/file/HelloWorld.c - -# Hỗ trợ Regular Expression! -$ git add ./*.java -``` - -### branch - -Quản lý nhánh (branch). Bạn có thể xem, sửa, tạo, xóa các nhánh bằng cách dùng lệnh này. - -```bash -# liệt kê các branch đang có và ở remote -$ git branch -a - -# tạo branch mới -$ git branch myNewBranch - -# xóa một branch -$ git branch -d myBranch - -# đặt tên lại một branch -# git branch -m -$ git branch -m myBranchName myNewBranchName - -# chỉnh sửa diễn giải của một branch -$ git branch myBranchName --edit-description -``` - -### checkout - -Cập nhật tất cả các file trong tree hiện tại để cho trùng khớp với phiên bản của index, hoặc tree cụ thể. - -```bash -# Checkout (chuyển) một repo - mặc định là nhánh master -$ git checkout -# Checkout một nhánh cụ thể -$ git checkout branchName -# Tạo một nhánh mới và chuyển đến nó, tương tự: "git branch ; git checkout " -$ git checkout -b newBranch -``` - -### clone - -Nhân bản, hoặc sao chép, một repo hiện có thành một thư mục mới. Nó cũng thêm -các branch có remote-tracking cho mỗi branch trong một repo được nhân bản, mà -cho phép bạn push đến một remote branch. - -```bash -# Nhân bản learnxinyminutes-docs -$ git clone https://github.com/adambard/learnxinyminutes-docs.git -``` - -### commit - -Lưu trữ nội dung hiện tại của index trong một "commit" mới. Điều này cho phép tạo ra thay đổi và một ghi chú tạo ra bởi người dùng. - -```bash -# commit với một ghi chú -$ git commit -m "Added multiplyNumbers() function to HelloWorld.c" -``` - -### diff - -Hiển thị sự khác biệt giữa một file trong thư mục hiện tại, index và commits. - -```bash -# Hiển thị sự khác biệt giữa thư mục hiện tại và index -$ git diff - -# Hiển thị khác biệt giữa index và commit mới nhất. -$ git diff --cached - -# Hiển thị khác biệt giữa thư mục đang làm việc và commit mới nhất -$ git diff HEAD -``` - -### grep - -Cho phép bạn tìm kiếm nhanh một repo. - -Các tinh chỉnh tùy chọn: - -```bash -# Cảm ơn Travis Jeffery vì những lệnh này -# Đặt số của dòng được hiển thị trong kết quả tìm kiếm grep -$ git config --global grep.lineNumber true - -# Làm cho kết quả tìm kiếm dễ đọc hơn, bao gồm cả gom nhóm -$ git config --global alias.g "grep --break --heading --line-number" -``` - -```bash -# Tìm "variableName" trong tất cả các file Java -$ git grep 'variableName' -- '*.java' - -# Tìm một dòng mà có chứa "arrayListName" và, "add" hoặc "remove" -$ git grep -e 'arrayListName' --and \( -e add -e remove \) -``` - -Google để xem thêm các ví dụ -[Git Grep Ninja](http://travisjeffery.com/b/2012/02/search-a-git-repo-like-a-ninja) - -### log - -Hiển thị các commit đến repo. - -```bash -# Hiện tất cả các commit -$ git log - -# Hiện X commit -$ git log -n 10 - -# Chỉ hiện các commit đã merge merge commits -$ git log --merges -``` - -### merge - -"Trộn" các thay đổi từ commit bên ngoài vào trong nhánh hiện tại. - -```bash -# Merge branch cụ thể vào branch hiện tại. -$ git merge branchName - -# Luôn khởi tạo một merge commit khi trộn (merge) -$ git merge --no-ff branchName -``` - -### mv - -Đặt lại tên hoặc di chuyển một file - -```bash -# Đặt lại tên một file -$ git mv HelloWorld.c HelloNewWorld.c - -# Di chuyển một file -$ git mv HelloWorld.c ./new/path/HelloWorld.c - -# Buộc đặt lại tên hoặc di chuyển -# "existingFile" đã tồn tại trong thự mục, sẽ bị ghi đè -$ git mv -f myFile existingFile -``` - -### pull - -Pull về từ một repo và merge nó vào branch khác. - -```bash -# Cập nhật repo local của bạn, bằng cách merge các thay đổi mới -# từ remote "origin" và nhánh "master". -# git pull -# git pull => hoàn toàn mặc định như => git pull origin master -$ git pull origin master - -# Merge các thay đổi từ remote branch và rebase -# các commit trong branch lên trên local repo, như sau: "git pull , git rebase " -$ git pull origin master --rebase -``` - -### push - -push và merge các thay đổi từ một branch đến một remote & branch. - + - ["Vinh Nguyen", "https://twitter.com/vinhnx"] +filename: LearnGit-vi.txt +lang: vi-vn +--- + +Git là một hệ quản lý mã nguồn và phiên bản phân tán (distributed version control and source code management system). + +Nó làm được điều này là do một loạt các snapshot từ đề án của bạn, và nó hoạt động +với các snapshot đó để cung cấp cho bạn với chức năng đến phiên bản và +quản lý mã nguồn của bạn. + +## Khái Niệm Versioning + +### Version Control là gì? + +Version Control là một hệ thống ghi lại những thay đổi ở một tập tin, hay một nhóm các tập tin, theo thời gian. + +### So sánh giữa Centralized Versioning và Distributed Versioning + +* Quản lý phiên bản tập trung (Centralized Versioning) tập trung vào việc đồng bộ hóa, theo dõi, và lưu trữ tập tin. +* Quản lý phiên bản phân tán (Distributed Versioning) tập trung vào việc chia sẻ các thay đổi. Mỗi sự thay đổi có một mã định dạng (id) duy nhất. +* Các hệ phân tán không có cấu trúc định sẵn. Bạn có thể thay đổi một kiểu SVN, hệ phân tán, với git. + +[Thông tin thêm](http://git-scm.com/book/en/Getting-Started-About-Version-Control) + +### Tại Sao Dùng Git? + +* Có thể hoạt động offline. +* Cộng tác với nhau rất dễ dàng! +* Phân nhánh dễ dàng! +* Trộn (Merging) +* Git nhanh. +* Git linh hoạt. + +## Kiến Trúc Git + + +### Repository + +Một nhóm các tập tin, thư mục, các ghi chép trong quá khứ, commit, và heads. Tưởng tượng nó như là một cấu trúc dữ liệu mã nguồn, +với thuộc tính mà một "nhân tố" mã nguồn cho bạn quyền truy cập đến lịch sử sửa đổi, và một số thứ khác. + +Một git repository bao gồm thư mục .git & tree đang làm việc. + +### Thư mục .git (thành phần của một repository) + +Thư mục .git chứa tất cả các cấu hình, log, nhánh, HEAD, và hơn nữa. +[Danh Sách Chi Tiết.](http://gitready.com/advanced/2009/03/23/whats-inside-your-git-directory.html) + +### Tree Đang Làm (thành phần của một repository) + +Đây cơ bản là các thư mục và tập tin trong repository của bạn. Nó thường được tham chiếu +thư mục đang làm việc của bạn + +### Chỉ mục (thành phần của một thư mục .git) + +Chỉ mục của là một staging area trong git. Nó đơn giản là một lớp riêng biệt với tree đang làm việc của bạn +từ Git repository. Điều này cho nhà phát triền nhiều lựa chọn hơn trong việc xem xét những gì được gửi đến Git +repository. + +### Commit + +Một git commit là một snapshot của một nhóm các thay đổi, hoặc các thao tác Working Tree của bạn. +Ví dụ, nếu bạn thêm 5 tập tin, và xóa 2 tập tin khác, những thay đổi này sẽ được chứa trong +một commit (hoặc snapshot). Commit này có thể được đẩy đến các repo khác, hoặc không! + +### Nhánh + +Nhánh thực chất là một con trỏ đến commit mới nhất mà bạn vừa thực hiện. Khi bạn commit, +con trỏ này sẽ cập nhật tự động và trỏ đến commit mới nhất. + +### HEAD và head (thành phần của thư mục .git) + +HEAD là một con trỏ đến branch hiện tại. Một repo chỉ có một HEAD *đang hoạt động*. +head là một con trỏ đến bất kỳ commit nào. Một repo có thể có nhiều head. + +### Các Tài Nguyên Mang Tính Khái Niệm + +* [Git For Computer Scientists](http://eagain.net/articles/git-for-computer-scientists/) +* [Git For Designers](http://hoth.entp.com/output/git_for_designers.html) + + +## Các Lệnh + + +### init + +Tạo một repo Git rỗng. Các cài đặt, thông tin lưu trữ... của Git +được lưu ở một thư mục tên là ".git". + +```bash +$ git init +``` + +### config + +Để chỉnh tùy chọn. Bất kể là cho repo, hay cho hệ thống, hay điều chỉnh +toàn cục (global) + + + +```bash +# In Ra & Và Gán Một Số Biến Tùy Chỉnh Cơ Bản (Toàn cục - Global) +$ git config --global user.email +$ git config --global user.name + +$ git config --global user.email "MyEmail@Zoho.com" +$ git config --global user.name "My Name" +``` + +[Tìm hiểu thêm về git config.](http://git-scm.com/docs/git-config) + +### help + +Để cho bạn lối truy cập nhanh đến một chỉ dẫn cực kỳ chi tiết của từng lệnh. Hoặc chỉ để +nhắc bạn một số cú pháp. + +```bash +# Xem nhanh các lệnh có sẵn +$ git help + +# Xem tất các các lệnh +$ git help -a + +# Lệnh help riêng biệt - tài liệu người dùng +# git help +$ git help add +$ git help commit +$ git help init +``` + +### status + +Để hiển thị sự khác nhau giữa tập tin index (cơ bản là repo đang làm việc) và HEAD commit +hiện tại. + + +```bash +# Sẽ hiển thị nhánh, các tập tin chưa track (chưa commit), các thay đổi và những khác biệt khác +$ git status + +# Để xem các "tid bits" về git status +$ git help status +``` + +### add + +Để thêm các tập vào tree/thư mục/repo hiện tại. Nếu bạn không `git add` các tập tin mới đến +tree/thư mục hiện tại, chúng sẽ không được kèm theo trong các commit! + +```bash +# thêm một file vào thư mục hiện tại +$ git add HelloWorld.java + +# thêm một file vào một thư mục khác +$ git add /path/to/file/HelloWorld.c + +# Hỗ trợ Regular Expression! +$ git add ./*.java +``` + +### branch + +Quản lý nhánh (branch). Bạn có thể xem, sửa, tạo, xóa các nhánh bằng cách dùng lệnh này. + +```bash +# liệt kê các branch đang có và ở remote +$ git branch -a + +# tạo branch mới +$ git branch myNewBranch + +# xóa một branch +$ git branch -d myBranch + +# đặt tên lại một branch +# git branch -m +$ git branch -m myBranchName myNewBranchName + +# chỉnh sửa diễn giải của một branch +$ git branch myBranchName --edit-description +``` + +### checkout + +Cập nhật tất cả các file trong tree hiện tại để cho trùng khớp với phiên bản của index, hoặc tree cụ thể. + +```bash +# Checkout (chuyển) một repo - mặc định là nhánh master +$ git checkout +# Checkout một nhánh cụ thể +$ git checkout branchName +# Tạo một nhánh mới và chuyển đến nó, tương tự: "git branch ; git checkout " +$ git checkout -b newBranch +``` + +### clone + +Nhân bản, hoặc sao chép, một repo hiện có thành một thư mục mới. Nó cũng thêm +các branch có remote-tracking cho mỗi branch trong một repo được nhân bản, mà +cho phép bạn push đến một remote branch. + +```bash +# Nhân bản learnxinyminutes-docs +$ git clone https://github.com/adambard/learnxinyminutes-docs.git +``` + +### commit + +Lưu trữ nội dung hiện tại của index trong một "commit" mới. Điều này cho phép tạo ra thay đổi và một ghi chú tạo ra bởi người dùng. + +```bash +# commit với một ghi chú +$ git commit -m "Added multiplyNumbers() function to HelloWorld.c" +``` + +### diff + +Hiển thị sự khác biệt giữa một file trong thư mục hiện tại, index và commits. + +```bash +# Hiển thị sự khác biệt giữa thư mục hiện tại và index +$ git diff + +# Hiển thị khác biệt giữa index và commit mới nhất. +$ git diff --cached + +# Hiển thị khác biệt giữa thư mục đang làm việc và commit mới nhất +$ git diff HEAD +``` + +### grep + +Cho phép bạn tìm kiếm nhanh một repo. + +Các tinh chỉnh tùy chọn: + +```bash +# Cảm ơn Travis Jeffery vì những lệnh này +# Đặt số của dòng được hiển thị trong kết quả tìm kiếm grep +$ git config --global grep.lineNumber true + +# Làm cho kết quả tìm kiếm dễ đọc hơn, bao gồm cả gom nhóm +$ git config --global alias.g "grep --break --heading --line-number" +``` + +```bash +# Tìm "variableName" trong tất cả các file Java +$ git grep 'variableName' -- '*.java' + +# Tìm một dòng mà có chứa "arrayListName" và, "add" hoặc "remove" +$ git grep -e 'arrayListName' --and \( -e add -e remove \) +``` + +Google để xem thêm các ví dụ +[Git Grep Ninja](http://travisjeffery.com/b/2012/02/search-a-git-repo-like-a-ninja) + +### log + +Hiển thị các commit đến repo. + +```bash +# Hiện tất cả các commit +$ git log + +# Hiện X commit +$ git log -n 10 + +# Chỉ hiện các commit đã merge merge commits +$ git log --merges +``` + +### merge + +"Trộn" các thay đổi từ commit bên ngoài vào trong nhánh hiện tại. + +```bash +# Merge branch cụ thể vào branch hiện tại. +$ git merge branchName + +# Luôn khởi tạo một merge commit khi trộn (merge) +$ git merge --no-ff branchName +``` + +### mv + +Đặt lại tên hoặc di chuyển một file + +```bash +# Đặt lại tên một file +$ git mv HelloWorld.c HelloNewWorld.c + +# Di chuyển một file +$ git mv HelloWorld.c ./new/path/HelloWorld.c + +# Buộc đặt lại tên hoặc di chuyển +# "existingFile" đã tồn tại trong thự mục, sẽ bị ghi đè +$ git mv -f myFile existingFile +``` + +### pull + +Pull về từ một repo và merge nó vào branch khác. + +```bash +# Cập nhật repo local của bạn, bằng cách merge các thay đổi mới +# từ remote "origin" và nhánh "master". +# git pull +# git pull => hoàn toàn mặc định như => git pull origin master +$ git pull origin master + +# Merge các thay đổi từ remote branch và rebase +# các commit trong branch lên trên local repo, như sau: "git pull , git rebase " +$ git pull origin master --rebase +``` + +### push + +push và merge các thay đổi từ một branch đến một remote & branch. + ```bash # Push và merge các thay đổi từ một repo local đến một # remote có tên là "origin" và nhánh "master". @@ -334,68 +334,68 @@ $ git push origin master $ git push -u origin master # Từ lúc này, bất cứ khi nào bạn muốn push từ cùng một nhánh local đó, sử dụng lối tắt: $ git push -``` - -### rebase (thận trọng) - -Lấy tất cả các thay đổi mà đã được commit trên một nhánh, và replay (?) chúng trên một nhánh khác. -*Không rebase các commit mà bạn đã push đến một repo công khai*. - -```bash -# Rebase experimentBranch lên master -# git rebase -$ git rebase master experimentBranch -``` - -[Đọc Thêm.](http://git-scm.com/book/en/Git-Branching-Rebasing) - -### reset (thận trọng) - -Thiết lập lạo HEAD hiện tại đến một trạng thái cụ thể. Điều này cho phép bạn làm lại các merges, -pulls, commits, thêm, and hơn nữa. Nó là một lệnh hay nhưng cũng nguy hiểm nếu bạn không -biết mình đang làm gì. - -```bash -# Thiết lập lại staging area, để trùng với commit mới nhất (để thư mục không thay đổi) -$ git reset - -# Thiết lập lại staging area, để trùng với commit mới nhất, và ghi đè lên thư mục hiện tại -$ git reset --hard - -# Di chuyển nhánh hiện tại đến một commit cụ thể (để thư mục không thay đổi) -# tất cả thay đổi vẫn duy trì trong thư mục. -$ git reset 31f2bb1 - -# Di chuyển nhánh hiện tại lùi về một commit cụ thể -# và làm cho thư mục hiện tại trùng (xóa các thay đổi chưa được commit và tất cả các commit -# sau một commit cụ thể). -$ git reset --hard 31f2bb1 -``` - -### rm - -Ngược lại với git add, git rm xóa file từ tree đang làm việc. - -```bash -# xóa HelloWorld.c -$ git rm HelloWorld.c - -# Xóa file từ thư mục khác -$ git rm /pather/to/the/file/HelloWorld.c -``` - -## Thông tin thêm - -* [tryGit - A fun interactive way to learn Git.](http://try.github.io/levels/1/challenges/1) - -* [git-scm - Video Tutorials](http://git-scm.com/videos) - -* [git-scm - Documentation](http://git-scm.com/docs) - -* [Atlassian Git - Tutorials & Workflows](https://www.atlassian.com/git/) - -* [SalesForce Cheat Sheet](https://na1.salesforce.com/help/doc/en/salesforce_git_developer_cheatsheet.pdf) - -* [Git - the simple guide](http://rogerdudler.github.io/git-guide/index.html) - +``` + +### rebase (thận trọng) + +Lấy tất cả các thay đổi mà đã được commit trên một nhánh, và replay (?) chúng trên một nhánh khác. +*Không rebase các commit mà bạn đã push đến một repo công khai*. + +```bash +# Rebase experimentBranch lên master +# git rebase +$ git rebase master experimentBranch +``` + +[Đọc Thêm.](http://git-scm.com/book/en/Git-Branching-Rebasing) + +### reset (thận trọng) + +Thiết lập lạo HEAD hiện tại đến một trạng thái cụ thể. Điều này cho phép bạn làm lại các merges, +pulls, commits, thêm, and hơn nữa. Nó là một lệnh hay nhưng cũng nguy hiểm nếu bạn không +biết mình đang làm gì. + +```bash +# Thiết lập lại staging area, để trùng với commit mới nhất (để thư mục không thay đổi) +$ git reset + +# Thiết lập lại staging area, để trùng với commit mới nhất, và ghi đè lên thư mục hiện tại +$ git reset --hard + +# Di chuyển nhánh hiện tại đến một commit cụ thể (để thư mục không thay đổi) +# tất cả thay đổi vẫn duy trì trong thư mục. +$ git reset 31f2bb1 + +# Di chuyển nhánh hiện tại lùi về một commit cụ thể +# và làm cho thư mục hiện tại trùng (xóa các thay đổi chưa được commit và tất cả các commit +# sau một commit cụ thể). +$ git reset --hard 31f2bb1 +``` + +### rm + +Ngược lại với git add, git rm xóa file từ tree đang làm việc. + +```bash +# xóa HelloWorld.c +$ git rm HelloWorld.c + +# Xóa file từ thư mục khác +$ git rm /pather/to/the/file/HelloWorld.c +``` + +## Thông tin thêm + +* [tryGit - A fun interactive way to learn Git.](http://try.github.io/levels/1/challenges/1) + +* [git-scm - Video Tutorials](http://git-scm.com/videos) + +* [git-scm - Documentation](http://git-scm.com/docs) + +* [Atlassian Git - Tutorials & Workflows](https://www.atlassian.com/git/) + +* [SalesForce Cheat Sheet](https://na1.salesforce.com/help/doc/en/salesforce_git_developer_cheatsheet.pdf) + +* [Git - the simple guide](http://rogerdudler.github.io/git-guide/index.html) + diff --git a/vi-vn/objective-c-vi.html.markdown b/vi-vn/objective-c-vi.html.markdown index 4656cf38..b01ce806 100644 --- a/vi-vn/objective-c-vi.html.markdown +++ b/vi-vn/objective-c-vi.html.markdown @@ -1,316 +1,316 @@ ---- -language: Objective-C -contributors: - - ["Eugene Yagrushkin", "www.about.me/yagrushkin"] - - ["Yannick Loriot", "https://github.com/YannickL"] -lang: vi-vn -filename: LearnObjectiveC-vi.m ---- - -Objective-C là ngôn ngữ lập trình chính được sử dụng bởi Apple cho các hệ điều hành macOS, iOS và các framework tương ứng của họ, Cocoa và Cocoa Touch. -Nó là một ngôn ngữ lập trình mục đích tổng quát, hướng đối tượng có bổ sung thêm kiểu truyền thông điệp giống Smalltalk vào ngôn ngữ lập trình C. - -```objective-c -// Chú thích dòng đơn bắt đầu với // - -/* -Chú thích đa dòng trông như thế này. -*/ - -// Nhập các headers của framework Foundation với cú pháp #import -#import -#import "MyClass.h" - -// Đầu vào chương trình của bạn là một hàm gọi là -// main với một kiểu trả về kiểu integer. -int main (int argc, const char * argv[]) -{ - // Tạo một autorelease pool để quản lý bộ nhớ vào chương trình - NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init]; - - // Sử dụng hàm NSLog() để in ra các dòng lệnh vào console - NSLog(@"Hello World!"); // Print the string "Hello World!" - - /////////////////////////////////////// - // Kiểu & Biến (Types & Variables) - /////////////////////////////////////// - - // Khai báo số nguyên - int myPrimitive1 = 1; - long myPrimitive2 = 234554664565; - - // Khai báo đối tượng - // Đặt dấu nháy * vào trước tên biến cho khai báo đối tượng strong - MyClass *myObject1 = nil; // Strong - id myObject2 = nil; // Weak - // %@ là một đối tượng - // 'miêu tả' ('desciption') là thông lệ để trình bày giá trị của các Đối tượng - NSLog(@"%@ và %@", myObject1, [myObject2 description]); // In ra "(null) và (null)" - - // Chuỗi - NSString *worldString = @"World"; - NSLog(@"Hello %@!", worldString); // In ra "Hello World!" - - // Ký tự literals - NSNumber *theLetterZNumber = @'Z'; - char theLetterZ = [theLetterZNumber charValue]; - NSLog(@"%c", theLetterZ); - - // Số nguyên literals - NSNumber *fortyTwoNumber = @42; - int fortyTwo = [fortyTwoNumber intValue]; - NSLog(@"%i", fortyTwo); - - NSNumber *fortyTwoUnsignedNumber = @42U; - unsigned int fortyTwoUnsigned = [fortyTwoUnsignedNumber unsignedIntValue]; - NSLog(@"%u", fortyTwoUnsigned); - - NSNumber *fortyTwoShortNumber = [NSNumber numberWithShort:42]; - short fortyTwoShort = [fortyTwoShortNumber shortValue]; - NSLog(@"%hi", fortyTwoShort); - - NSNumber *fortyTwoLongNumber = @42L; - long fortyTwoLong = [fortyTwoLongNumber longValue]; - NSLog(@"%li", fortyTwoLong); - - // Dấu phẩy động (floating point) literals - NSNumber *piFloatNumber = @3.141592654F; - float piFloat = [piFloatNumber floatValue]; - NSLog(@"%f", piFloat); - - NSNumber *piDoubleNumber = @3.1415926535; - double piDouble = [piDoubleNumber doubleValue]; - NSLog(@"%f", piDouble); - - // BOOL literals - NSNumber *yesNumber = @YES; - NSNumber *noNumber = @NO; - - // Đối tượng Mảng - NSArray *anArray = @[@1, @2, @3, @4]; - NSNumber *thirdNumber = anArray[2]; - NSLog(@"Third number = %@", thirdNumber); // In ra "Third number = 3" - - // Đối tượng Từ điển - NSDictionary *aDictionary = @{ @"key1" : @"value1", @"key2" : @"value2" }; - NSObject *valueObject = aDictionary[@"A Key"]; - NSLog(@"Đối tượng = %@", valueObject); // In ra "Object = (null)" - - /////////////////////////////////////// - // Toán Tử (Operators) - /////////////////////////////////////// - - // Các toán tử cũng hoạt động giống như ngôn ngữ C - // Ví dụ: - 2 + 5; // => 7 - 4.2f + 5.1f; // => 9.3f - 3 == 2; // => 0 (NO) - 3 != 2; // => 1 (YES) - 1 && 1; // => 1 (Logical and) - 0 || 1; // => 1 (Logical or) - ~0x0F; // => 0xF0 (bitwise negation) - 0x0F & 0xF0; // => 0x00 (bitwise AND) - 0x01 << 1; // => 0x02 (bitwise dịch trái (bởi 1)) - - ///////////////////////////////////////////// - // Cấu Trúc Điều Khiển (Controls Structures) - ///////////////////////////////////////////// - - // Câu lệnh If-Else - if (NO) - { - NSLog(@"I am never run"); - } else if (0) - { - NSLog(@"I am also never run"); - } else - { - NSLog(@"I print"); - } - - // Câu lệnh Switch - switch (2) - { - case 0: - { - NSLog(@"I am never run"); - } break; - case 1: - { - NSLog(@"I am also never run"); - } break; - default: - { - NSLog(@"I print"); - } break; - } - - // Câu lệnh vòng lặp While - int ii = 0; - while (ii < 4) - { - NSLog(@"%d,", ii++); // ii++ tăng dần, sau khi sử dụng giá trị của nó. - } // => in ra "0," - // "1," - // "2," - // "3," - - // Câu lệnh vòng lặp For - int jj; - for (jj=0; jj < 4; jj++) - { - NSLog(@"%d,", jj); - } // => in ra "0," - // "1," - // "2," - // "3," - - // Câu lệnh Foreach - NSArray *values = @[@0, @1, @2, @3]; - for (NSNumber *value in values) - { - NSLog(@"%@,", value); - } // => in ra "0," - // "1," - // "2," - // "3," - - // Câu lệnh Try-Catch-Finally - @try - { - // Your statements here - @throw [NSException exceptionWithName:@"FileNotFoundException" - reason:@"Không Tìm Thấy Tập Tin trên Hệ Thống" userInfo:nil]; - } @catch (NSException * e) - { - NSLog(@"Exception: %@", e); - } @finally - { - NSLog(@"Finally"); - } // => in ra "Exception: Không Tìm Thấy Tập Tin trên Hệ Thống" - // "Finally" - - /////////////////////////////////////// - // Đối Tượng (Objects) - /////////////////////////////////////// - - // Tạo một thực thể đối tượng bằng cách phân vùng nhớ và khởi tạo đối tượng đó. - // Một đối tượng sẽ không thật sự hoạt động cho đến khi cả 2 bước alloc] init] được hoàn thành - MyClass *myObject = [[MyClass alloc] init]; - - // Mô hình lập trình hướng đối tượng của Objective-C dựa trên việc truyền thông điệp (message) - // và các thực thể đối tượng với nhau. - // Trong Objective-C một đối tượng không đơn thuần gọi phương thức; nó truyền thông điệp. - [myObject instanceMethodWithParameter:@"Steve Jobs"]; - - // Dọn dẹp vùng nhớ mà bạn đã dùng ở chương trình - [pool drain]; - - // Kết thúc chương trình - return 0; -} - -/////////////////////////////////////// -// Lớp và Hàm (Classes & Functions) -/////////////////////////////////////// - -// Khai báo lớp của bạn ở một tập tin header (MyClass.h): -// Cú pháp Khai Báo Lớp: -// @interface ClassName : ParentClassName -// { -// Khai báo biến thành viên; -// } -// -/+ (type) Khai báo method; -// @end -@interface MyClass : NSObject -{ - int count; - id data; - NSString *name; -} -// Ký hiệu (notation) tiện ích để tự động khởi tạo public getter và setter -@property int count; -@property (copy) NSString *name; // Sao chép đối tượng trong quá trình gán. -@property (readonly) id data; // Chỉ khai báo phương thức getter. - -// Phương thức -+/- (return type)methodSignature:(Parameter Type *)parameterName; - -// dấu '+' cho phương thức lớp -+ (NSString *)classMethod; - -// dấu '-' cho phương thức thực thể -- (NSString *)instanceMethodWithParameter:(NSString *)string; -- (NSNumber *)methodAParameterAsString:(NSString*)string andAParameterAsNumber:(NSNumber *)number; - -@end - -// Thực thi các phương thức trong một tập tin thực thi (MyClass.m): - -@implementation MyClass - -// Gọi khi đối tượng được release -- (void)dealloc -{ -} - -// Phương thức khởi tạo (Constructors) là một cách để tạo các lớp -// Đây là phương thức khởi tạo mặc định được gọi khi đối tượng được khởi tạo -- (id)init -{ - if ((self = [super init])) - { - self.count = 1; - } - return self; -} - -+ (NSString *)classMethod -{ - return [[self alloc] init]; -} - -- (NSString *)instanceMethodWithParameter:(NSString *)string -{ - return @"New string"; -} - -- (NSNumber *)methodAParameterAsString:(NSString*)string andAParameterAsNumber:(NSNumber *)number -{ - return @42; -} - -// Các phương thức được khai báo vào MyProtocol -- (void)myProtocolMethod -{ - // câu lệnh -} - -@end - -/* - * Một protocol khai báo các phương thức mà có thể thực thi bởi bất kỳ lớp nào. - * Các protocol chính chúng không phải là các lớp. Chúng chỉ đơn giản là định ra giao diện (interface) - * mà các đối tượng khác có trách nhiệm sẽ thực thi. - */ -@protocol MyProtocol - - (void)myProtocolMethod; -@end - - - -``` -## Xem Thêm - -+ [Wikipedia Objective-C](http://en.wikipedia.org/wiki/Objective-C) - -+ Apple Docs': - + [Learning Objective-C](http://developer.apple.com/library/ios/referencelibrary/GettingStarted/Learning_Objective-C_A_Primer/) - - + [Programming With Objective-C](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html) - - + [Object-Oriented Programming with Objective-C](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/OOP_ObjC/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005149) - - + [Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html) - -+ [iOS For High School Students: Getting Started](http://www.raywenderlich.com/5600/ios-for-high-school-students-getting-started) +--- +language: Objective-C +contributors: + - ["Eugene Yagrushkin", "www.about.me/yagrushkin"] + - ["Yannick Loriot", "https://github.com/YannickL"] +lang: vi-vn +filename: LearnObjectiveC-vi.m +--- + +Objective-C là ngôn ngữ lập trình chính được sử dụng bởi Apple cho các hệ điều hành macOS, iOS và các framework tương ứng của họ, Cocoa và Cocoa Touch. +Nó là một ngôn ngữ lập trình mục đích tổng quát, hướng đối tượng có bổ sung thêm kiểu truyền thông điệp giống Smalltalk vào ngôn ngữ lập trình C. + +```objective-c +// Chú thích dòng đơn bắt đầu với // + +/* +Chú thích đa dòng trông như thế này. +*/ + +// Nhập các headers của framework Foundation với cú pháp #import +#import +#import "MyClass.h" + +// Đầu vào chương trình của bạn là một hàm gọi là +// main với một kiểu trả về kiểu integer. +int main (int argc, const char * argv[]) +{ + // Tạo một autorelease pool để quản lý bộ nhớ vào chương trình + NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init]; + + // Sử dụng hàm NSLog() để in ra các dòng lệnh vào console + NSLog(@"Hello World!"); // Print the string "Hello World!" + + /////////////////////////////////////// + // Kiểu & Biến (Types & Variables) + /////////////////////////////////////// + + // Khai báo số nguyên + int myPrimitive1 = 1; + long myPrimitive2 = 234554664565; + + // Khai báo đối tượng + // Đặt dấu nháy * vào trước tên biến cho khai báo đối tượng strong + MyClass *myObject1 = nil; // Strong + id myObject2 = nil; // Weak + // %@ là một đối tượng + // 'miêu tả' ('desciption') là thông lệ để trình bày giá trị của các Đối tượng + NSLog(@"%@ và %@", myObject1, [myObject2 description]); // In ra "(null) và (null)" + + // Chuỗi + NSString *worldString = @"World"; + NSLog(@"Hello %@!", worldString); // In ra "Hello World!" + + // Ký tự literals + NSNumber *theLetterZNumber = @'Z'; + char theLetterZ = [theLetterZNumber charValue]; + NSLog(@"%c", theLetterZ); + + // Số nguyên literals + NSNumber *fortyTwoNumber = @42; + int fortyTwo = [fortyTwoNumber intValue]; + NSLog(@"%i", fortyTwo); + + NSNumber *fortyTwoUnsignedNumber = @42U; + unsigned int fortyTwoUnsigned = [fortyTwoUnsignedNumber unsignedIntValue]; + NSLog(@"%u", fortyTwoUnsigned); + + NSNumber *fortyTwoShortNumber = [NSNumber numberWithShort:42]; + short fortyTwoShort = [fortyTwoShortNumber shortValue]; + NSLog(@"%hi", fortyTwoShort); + + NSNumber *fortyTwoLongNumber = @42L; + long fortyTwoLong = [fortyTwoLongNumber longValue]; + NSLog(@"%li", fortyTwoLong); + + // Dấu phẩy động (floating point) literals + NSNumber *piFloatNumber = @3.141592654F; + float piFloat = [piFloatNumber floatValue]; + NSLog(@"%f", piFloat); + + NSNumber *piDoubleNumber = @3.1415926535; + double piDouble = [piDoubleNumber doubleValue]; + NSLog(@"%f", piDouble); + + // BOOL literals + NSNumber *yesNumber = @YES; + NSNumber *noNumber = @NO; + + // Đối tượng Mảng + NSArray *anArray = @[@1, @2, @3, @4]; + NSNumber *thirdNumber = anArray[2]; + NSLog(@"Third number = %@", thirdNumber); // In ra "Third number = 3" + + // Đối tượng Từ điển + NSDictionary *aDictionary = @{ @"key1" : @"value1", @"key2" : @"value2" }; + NSObject *valueObject = aDictionary[@"A Key"]; + NSLog(@"Đối tượng = %@", valueObject); // In ra "Object = (null)" + + /////////////////////////////////////// + // Toán Tử (Operators) + /////////////////////////////////////// + + // Các toán tử cũng hoạt động giống như ngôn ngữ C + // Ví dụ: + 2 + 5; // => 7 + 4.2f + 5.1f; // => 9.3f + 3 == 2; // => 0 (NO) + 3 != 2; // => 1 (YES) + 1 && 1; // => 1 (Logical and) + 0 || 1; // => 1 (Logical or) + ~0x0F; // => 0xF0 (bitwise negation) + 0x0F & 0xF0; // => 0x00 (bitwise AND) + 0x01 << 1; // => 0x02 (bitwise dịch trái (bởi 1)) + + ///////////////////////////////////////////// + // Cấu Trúc Điều Khiển (Controls Structures) + ///////////////////////////////////////////// + + // Câu lệnh If-Else + if (NO) + { + NSLog(@"I am never run"); + } else if (0) + { + NSLog(@"I am also never run"); + } else + { + NSLog(@"I print"); + } + + // Câu lệnh Switch + switch (2) + { + case 0: + { + NSLog(@"I am never run"); + } break; + case 1: + { + NSLog(@"I am also never run"); + } break; + default: + { + NSLog(@"I print"); + } break; + } + + // Câu lệnh vòng lặp While + int ii = 0; + while (ii < 4) + { + NSLog(@"%d,", ii++); // ii++ tăng dần, sau khi sử dụng giá trị của nó. + } // => in ra "0," + // "1," + // "2," + // "3," + + // Câu lệnh vòng lặp For + int jj; + for (jj=0; jj < 4; jj++) + { + NSLog(@"%d,", jj); + } // => in ra "0," + // "1," + // "2," + // "3," + + // Câu lệnh Foreach + NSArray *values = @[@0, @1, @2, @3]; + for (NSNumber *value in values) + { + NSLog(@"%@,", value); + } // => in ra "0," + // "1," + // "2," + // "3," + + // Câu lệnh Try-Catch-Finally + @try + { + // Your statements here + @throw [NSException exceptionWithName:@"FileNotFoundException" + reason:@"Không Tìm Thấy Tập Tin trên Hệ Thống" userInfo:nil]; + } @catch (NSException * e) + { + NSLog(@"Exception: %@", e); + } @finally + { + NSLog(@"Finally"); + } // => in ra "Exception: Không Tìm Thấy Tập Tin trên Hệ Thống" + // "Finally" + + /////////////////////////////////////// + // Đối Tượng (Objects) + /////////////////////////////////////// + + // Tạo một thực thể đối tượng bằng cách phân vùng nhớ và khởi tạo đối tượng đó. + // Một đối tượng sẽ không thật sự hoạt động cho đến khi cả 2 bước alloc] init] được hoàn thành + MyClass *myObject = [[MyClass alloc] init]; + + // Mô hình lập trình hướng đối tượng của Objective-C dựa trên việc truyền thông điệp (message) + // và các thực thể đối tượng với nhau. + // Trong Objective-C một đối tượng không đơn thuần gọi phương thức; nó truyền thông điệp. + [myObject instanceMethodWithParameter:@"Steve Jobs"]; + + // Dọn dẹp vùng nhớ mà bạn đã dùng ở chương trình + [pool drain]; + + // Kết thúc chương trình + return 0; +} + +/////////////////////////////////////// +// Lớp và Hàm (Classes & Functions) +/////////////////////////////////////// + +// Khai báo lớp của bạn ở một tập tin header (MyClass.h): +// Cú pháp Khai Báo Lớp: +// @interface ClassName : ParentClassName +// { +// Khai báo biến thành viên; +// } +// -/+ (type) Khai báo method; +// @end +@interface MyClass : NSObject +{ + int count; + id data; + NSString *name; +} +// Ký hiệu (notation) tiện ích để tự động khởi tạo public getter và setter +@property int count; +@property (copy) NSString *name; // Sao chép đối tượng trong quá trình gán. +@property (readonly) id data; // Chỉ khai báo phương thức getter. + +// Phương thức ++/- (return type)methodSignature:(Parameter Type *)parameterName; + +// dấu '+' cho phương thức lớp ++ (NSString *)classMethod; + +// dấu '-' cho phương thức thực thể +- (NSString *)instanceMethodWithParameter:(NSString *)string; +- (NSNumber *)methodAParameterAsString:(NSString*)string andAParameterAsNumber:(NSNumber *)number; + +@end + +// Thực thi các phương thức trong một tập tin thực thi (MyClass.m): + +@implementation MyClass + +// Gọi khi đối tượng được release +- (void)dealloc +{ +} + +// Phương thức khởi tạo (Constructors) là một cách để tạo các lớp +// Đây là phương thức khởi tạo mặc định được gọi khi đối tượng được khởi tạo +- (id)init +{ + if ((self = [super init])) + { + self.count = 1; + } + return self; +} + ++ (NSString *)classMethod +{ + return [[self alloc] init]; +} + +- (NSString *)instanceMethodWithParameter:(NSString *)string +{ + return @"New string"; +} + +- (NSNumber *)methodAParameterAsString:(NSString*)string andAParameterAsNumber:(NSNumber *)number +{ + return @42; +} + +// Các phương thức được khai báo vào MyProtocol +- (void)myProtocolMethod +{ + // câu lệnh +} + +@end + +/* + * Một protocol khai báo các phương thức mà có thể thực thi bởi bất kỳ lớp nào. + * Các protocol chính chúng không phải là các lớp. Chúng chỉ đơn giản là định ra giao diện (interface) + * mà các đối tượng khác có trách nhiệm sẽ thực thi. + */ +@protocol MyProtocol + - (void)myProtocolMethod; +@end + + + +``` +## Xem Thêm + ++ [Wikipedia Objective-C](http://en.wikipedia.org/wiki/Objective-C) + ++ Apple Docs': + + [Learning Objective-C](http://developer.apple.com/library/ios/referencelibrary/GettingStarted/Learning_Objective-C_A_Primer/) + + + [Programming With Objective-C](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/Introduction/Introduction.html) + + + [Object-Oriented Programming with Objective-C](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/OOP_ObjC/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005149) + + + [Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html) + ++ [iOS For High School Students: Getting Started](http://www.raywenderlich.com/5600/ios-for-high-school-students-getting-started) diff --git a/zh-cn/c++-cn.html.markdown b/zh-cn/c++-cn.html.markdown index a6a61949..db36ebc4 100644 --- a/zh-cn/c++-cn.html.markdown +++ b/zh-cn/c++-cn.html.markdown @@ -1,572 +1,572 @@ ---- -language: C++ -filename: learncpp-cn.cpp -contributors: - - ["Steven Basart", "http://github.com/xksteven"] - - ["Matt Kline", "https://github.com/mrkline"] -translators: - - ["Arnie97", "https://github.com/Arnie97"] -lang: zh-cn ---- - -C++是一种系统编程语言。用它的发明者， -[Bjarne Stroustrup的话](http://channel9.msdn.com/Events/Lang-NEXT/Lang-NEXT-2014/Keynote)来说，C++的设计目标是： - -- 成为“更好的C语言” -- 支持数据的抽象与封装 -- 支持面向对象编程 -- 支持泛型编程 - -C++提供了对硬件的紧密控制（正如C语言一样）， -能够编译为机器语言，由处理器直接执行。 -与此同时，它也提供了泛型、异常和类等高层功能。 -虽然C++的语法可能比某些出现较晚的语言更复杂，它仍然得到了人们的青睞—— -功能与速度的平衡使C++成为了目前应用最广泛的系统编程语言之一。 - -```c++ -//////////////// -// 与C语言的比较 -//////////////// - -// C++_几乎_是C语言的一个超集，它与C语言的基本语法有许多相同之处， -// 例如变量和函数的声明，原生数据类型等等。 - -// 和C语言一样，在C++中，你的程序会从main()开始执行， -// 该函数的返回值应当为int型，这个返回值会作为程序的退出状态值。 -// 不过，大多数的编译器（gcc，clang等）也接受 void main() 的函数原型。 -// （参见 http://en.wikipedia.org/wiki/Exit_status 来获取更多信息） -int main(int argc, char** argv) -{ - // 和C语言一样，命令行参数通过argc和argv传递。 - // argc代表命令行参数的数量， - // 而argv是一个包含“C语言风格字符串”（char *）的数组， - // 其中每个字符串代表一个命令行参数的内容， - // 首个命令行参数是调用该程序时所使用的名称。 - // 如果你不关心命令行参数的值，argc和argv可以被忽略。 - // 此时，你可以用int main()作为函数原型。 - - // 退出状态值为0时，表示程序执行成功 - return 0; -} - -// 然而，C++和C语言也有一些区别： - -// 在C++中，字符字面量的大小是一个字节。 -sizeof('c') == 1 - -// 在C语言中，字符字面量的大小与int相同。 -sizeof('c') == sizeof(10) - - -// C++的函数原型与函数定义是严格匹配的 -void func(); // 这个函数不能接受任何参数 - -// 而在C语言中 -void func(); // 这个函数能接受任意数量的参数 - -// 在C++中，用nullptr代替C语言中的NULL -int* ip = nullptr; - -// C++也可以使用C语言的标准头文件， -// 但是需要加上前缀“c”并去掉末尾的“.h”。 -#include - -int main() -{ - printf("Hello, world!\n"); - return 0; -} - -/////////// -// 函数重载 -/////////// - -// C++支持函数重载，你可以定义一组名称相同而参数不同的函数。 - -void print(char const* myString) -{ - printf("String %s\n", myString); -} - -void print(int myInt) -{ - printf("My int is %d", myInt); -} - -int main() -{ - print("Hello"); // 解析为 void print(const char*) - print(15); // 解析为 void print(int) -} - -/////////////////// -// 函数参数的默认值 -/////////////////// - -// 你可以为函数的参数指定默认值， -// 它们将会在调用者没有提供相应参数时被使用。 - -void doSomethingWithInts(int a = 1, int b = 4) -{ - // 对两个参数进行一些操作 -} - -int main() -{ - doSomethingWithInts(); // a = 1, b = 4 - doSomethingWithInts(20); // a = 20, b = 4 - doSomethingWithInts(20, 5); // a = 20, b = 5 -} - -// 默认参数必须放在所有的常规参数之后。 - -void invalidDeclaration(int a = 1, int b) // 这是错误的！ -{ -} - - -/////////// -// 命名空间 -/////////// - -// 命名空间为变量、函数和其他声明提供了分离的的作用域。 -// 命名空间可以嵌套使用。 - -namespace First { - namespace Nested { - void foo() - { - printf("This is First::Nested::foo\n"); - } - } // 结束嵌套的命名空间Nested -} // 结束命名空间First - -namespace Second { - void foo() - { - printf("This is Second::foo\n") - } -} - -void foo() -{ - printf("This is global foo\n"); -} - -int main() -{ - // 如果没有特别指定，就从“Second”中取得所需的内容。 - using namespace Second; - - foo(); // 显示“This is Second::foo” - First::Nested::foo(); // 显示“This is First::Nested::foo” - ::foo(); // 显示“This is global foo” -} - -//////////// -// 输入/输出 -//////////// - -// C++使用“流”来输入输出。<<是流的插入运算符，>>是流提取运算符。 -// cin、cout、和cerr分别代表 -// stdin（标准输入）、stdout（标准输出）和stderr（标准错误）。 - -#include // 引入包含输入/输出流的头文件 - -using namespace std; // 输入输出流在std命名空间（也就是标准库）中。 - -int main() -{ - int myInt; - - // 在标准输出（终端/显示器）中显示 - cout << "Enter your favorite number:\n"; - // 从标准输入（键盘）获得一个值 - cin >> myInt; - - // cout也提供了格式化功能 - cout << "Your favorite number is " << myInt << "\n"; - // 显示“Your favorite number is ” - - cerr << "Used for error messages"; -} - -///////// -// 字符串 -///////// - -// C++中的字符串是对象，它们有很多成员函数 -#include - -using namespace std; // 字符串也在std命名空间（标准库）中。 - -string myString = "Hello"; -string myOtherString = " World"; - -// + 可以用于连接字符串。 -cout << myString + myOtherString; // "Hello World" - -cout << myString + " You"; // "Hello You" - -// C++中的字符串是可变的，具有“值语义”。 -myString.append(" Dog"); -cout << myString; // "Hello Dog" - - -///////////// -// 引用 -///////////// - -// 除了支持C语言中的指针类型以外，C++还提供了_引用_。 -// 引用是一种特殊的指针类型，一旦被定义就不能重新赋值，并且不能被设置为空值。 -// 使用引用时的语法与原变量相同： -// 也就是说，对引用类型进行解引用时，不需要使用*； -// 赋值时也不需要用&来取地址。 - -using namespace std; - -string foo = "I am foo"; -string bar = "I am bar"; - - -string& fooRef = foo; // 建立了一个对foo的引用。 -fooRef += ". Hi!"; // 通过引用来修改foo的值 -cout << fooRef; // "I am foo. Hi!" - -// 这句话的并不会改变fooRef的指向，其效果与“foo = bar”相同。 -// 也就是说，在执行这条语句之后，foo == "I am bar"。 -fooRef = bar; - -const string& barRef = bar; // 建立指向bar的常量引用。 -// 和C语言中一样，（指针和引用）声明为常量时，对应的值不能被修改。 -barRef += ". Hi!"; // 这是错误的，不能修改一个常量引用的值。 - -/////////////////// -// 类与面向对象编程 -/////////////////// - -// 有关类的第一个示例 -#include - -// 声明一个类。 -// 类通常在头文件（.h或.hpp）中声明。 -class Dog { - // 成员变量和成员函数默认情况下是私有（private）的。 - std::string name; - int weight; - -// 在这个标签之后，所有声明都是公有（public）的， -// 直到重新指定“private:”（私有继承）或“protected:”（保护继承）为止 -public: - - // 默认的构造器 - Dog(); - - // 这里是成员函数声明的一个例子。 - // 可以注意到，我们在此处使用了std::string，而不是using namespace std - // 语句using namespace绝不应当出现在头文件当中。 - void setName(const std::string& dogsName); - - void setWeight(int dogsWeight); - - // 如果一个函数不对对象的状态进行修改， - // 应当在声明中加上const。 - // 这样，你就可以对一个以常量方式引用的对象执行该操作。 - // 同时可以注意到，当父类的成员函数需要被子类重写时， - // 父类中的函数必须被显式声明为_虚函数（virtual）_。 - // 考虑到性能方面的因素，函数默认情况下不会被声明为虚函数。 - virtual void print() const; - - // 函数也可以在class body内部定义。 - // 这样定义的函数会自动成为内联函数。 - void bark() const { std::cout << name << " barks!\n" } - - // 除了构造器以外，C++还提供了析构器。 - // 当一个对象被删除或者脱离其定义域时，它的析构函数会被调用。 - // 这使得RAII这样的强大范式（参见下文）成为可能。 - // 为了衍生出子类来，基类的析构函数必须定义为虚函数。 - virtual ~Dog(); - -}; // 在类的定义之后，要加一个分号 - -// 类的成员函数通常在.cpp文件中实现。 -void Dog::Dog() -{ - std::cout << "A dog has been constructed\n"; -} - -// 对象（例如字符串）应当以引用的形式传递， -// 对于不需要修改的对象，最好使用常量引用。 -void Dog::setName(const std::string& dogsName) -{ - name = dogsName; -} - -void Dog::setWeight(int dogsWeight) -{ - weight = dogsWeight; -} - -// 虚函数的virtual关键字只需要在声明时使用，不需要在定义时重复 -void Dog::print() const -{ - std::cout << "Dog is " << name << " and weighs " << weight << "kg\n"; -} - -void Dog::~Dog() -{ - std::cout << "Goodbye " << name << "\n"; -} - -int main() { - Dog myDog; // 此时显示“A dog has been constructed” - myDog.setName("Barkley"); - myDog.setWeight(10); - myDog.print(); // 显示“Dog is Barkley and weighs 10 kg” - return 0; -} // 显示“Goodbye Barkley” - -// 继承： - -// 这个类继承了Dog类中的公有（public）和保护（protected）对象 -class OwnedDog : public Dog { - - void setOwner(const std::string& dogsOwner) - - // 重写OwnedDogs类的print方法。 - // 如果你不熟悉子类多态的话，可以参考这个页面中的概述： - // http://zh.wikipedia.org/wiki/%E5%AD%90%E7%B1%BB%E5%9E%8B - - // override关键字是可选的，它确保你所重写的是基类中的方法。 - void print() const override; - -private: - std::string owner; -}; - -// 与此同时，在对应的.cpp文件里： - -void OwnedDog::setOwner(const std::string& dogsOwner) -{ - owner = dogsOwner; -} - -void OwnedDog::print() const -{ - Dog::print(); // 调用基类Dog中的print方法 - // "Dog is and weights " - - std::cout << "Dog is owned by " << owner << "\n"; - // "Dog is owned by " -} - -///////////////////// -// 初始化与运算符重载 -///////////////////// - -// 在C++中，通过定义一些特殊名称的函数， -// 你可以重载+、-、*、/等运算符的行为。 -// 当运算符被使用时，这些特殊函数会被调用，从而实现运算符重载。 - -#include -using namespace std; - -class Point { -public: - // 可以以这样的方式为成员变量设置默认值。 - double x = 0; - double y = 0; - - // 定义一个默认的构造器。 - // 除了将Point初始化为(0, 0)以外，这个函数什么都不做。 - Point() { }; - - // 下面使用的语法称为初始化列表， - // 这是初始化类中成员变量的正确方式。 - Point (double a, double b) : - x(a), - y(b) - { /* 除了初始化成员变量外，什么都不做 */ } - - // 重载 + 运算符 - Point operator+(const Point& rhs) const; - - // 重载 += 运算符 - Point& operator+=(const Point& rhs); - - // 增加 - 和 -= 运算符也是有意义的，但这里不再赘述。 -}; - -Point Point::operator+(const Point& rhs) const -{ - // 创建一个新的点， - // 其横纵坐标分别为这个点与另一点在对应方向上的坐标之和。 - return Point(x + rhs.x, y + rhs.y); -} - -Point& Point::operator+=(const Point& rhs) -{ - x += rhs.x; - y += rhs.y; - return *this; -} - -int main () { - Point up (0,1); - Point right (1,0); - // 这里使用了Point类型的运算符“+” - // 调用up（Point类型）的“+”方法，并以right作为函数的参数 - Point result = up + right; - // 显示“Result is upright (1,1)” - cout << "Result is upright (" << result.x << ',' << result.y << ")\n"; - return 0; -} - -/////////// -// 异常处理 -/////////// - -// 标准库中提供了一些基本的异常类型 -// （参见http://en.cppreference.com/w/cpp/error/exception） -// 但是，其他任何类型也可以作为一个异常被拋出 -#include - -// 在_try_代码块中拋出的异常可以被随后的_catch_捕获。 -try { - // 不要用 _new_关键字在堆上为异常分配空间。 - throw std::exception("A problem occurred"); -} -// 如果拋出的异常是一个对象，可以用常量引用来捕获它 -catch (const std::exception& ex) -{ - std::cout << ex.what(); -// 捕获尚未被_catch_处理的所有错误 -} catch (...) -{ - std::cout << "Unknown exception caught"; - throw; // 重新拋出异常 -} - -/////// -// RAII -/////// - -// RAII指的是“资源获取就是初始化”（Resource Allocation Is Initialization）， -// 它被视作C++中最强大的编程范式之一。 -// 简单说来，它指的是，用构造函数来获取一个对象的资源， -// 相应的，借助析构函数来释放对象的资源。 - -// 为了理解这一范式的用处，让我们考虑某个函数使用文件句柄时的情况： -void doSomethingWithAFile(const char* filename) -{ - // 首先，让我们假设一切都会顺利进行。 - - FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 - - doSomethingWithTheFile(fh); - doSomethingElseWithIt(fh); - - fclose(fh); // 关闭文件句柄 -} - -// 不幸的是，随着错误处理机制的引入，事情会变得复杂。 -// 假设fopen函数有可能执行失败， -// 而doSomethingWithTheFile和doSomethingElseWithIt会在失败时返回错误代码。 -// （虽然异常是C++中处理错误的推荐方式， -// 但是某些程序员，尤其是有C语言背景的，并不认可异常捕获机制的作用）。 -// 现在，我们必须检查每个函数调用是否成功执行，并在问题发生的时候关闭文件句柄。 -bool doSomethingWithAFile(const char* filename) -{ - FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 - if (fh == nullptr) // 当执行失败是，返回的指针是nullptr - return false; // 向调用者汇报错误 - - // 假设每个函数会在执行失败时返回false - if (!doSomethingWithTheFile(fh)) { - fclose(fh); // 关闭文件句柄，避免造成内存泄漏。 - return false; // 反馈错误 - } - if (!doSomethingElseWithIt(fh)) { - fclose(fh); // 关闭文件句柄 - return false; // 反馈错误 - } - - fclose(fh); // 关闭文件句柄 - return true; // 指示函数已成功执行 -} - -// C语言的程序员通常会借助goto语句简化上面的代码： -bool doSomethingWithAFile(const char* filename) -{ - FILE* fh = fopen(filename, "r"); - if (fh == nullptr) - return false; - - if (!doSomethingWithTheFile(fh)) - goto failure; - - if (!doSomethingElseWithIt(fh)) - goto failure; - - fclose(fh); // 关闭文件 - return true; // 执行成功 - -failure: - fclose(fh); - return false; // 反馈错误 -} - -// 如果用异常捕获机制来指示错误的话， -// 代码会变得清晰一些，但是仍然有优化的余地。 -void doSomethingWithAFile(const char* filename) -{ - FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 - if (fh == nullptr) - throw std::exception("Could not open the file."); - - try { - doSomethingWithTheFile(fh); - doSomethingElseWithIt(fh); - } - catch (...) { - fclose(fh); // 保证出错的时候文件被正确关闭 - throw; // 之后，重新抛出这个异常 - } - - fclose(fh); // 关闭文件 - // 所有工作顺利完成 -} - -// 相比之下，使用C++中的文件流类（fstream）时， -// fstream会利用自己的析构器来关闭文件句柄。 -// 只要离开了某一对象的定义域，它的析构函数就会被自动调用。 -void doSomethingWithAFile(const std::string& filename) -{ - // ifstream是输入文件流（input file stream）的简称 - std::ifstream fh(filename); // 打开一个文件 - - // 对文件进行一些操作 - doSomethingWithTheFile(fh); - doSomethingElseWithIt(fh); - -} // 文件已经被析构器自动关闭 - -// 与上面几种方式相比，这种方式有着_明显_的优势： -// 1. 无论发生了什么情况，资源（此例当中是文件句柄）都会被正确关闭。 -// 只要你正确使用了析构器，就_不会_因为忘记关闭句柄，造成资源的泄漏。 -// 2. 可以注意到，通过这种方式写出来的代码十分简洁。 -// 析构器会在后台关闭文件句柄，不再需要你来操心这些琐事。 -// 3. 这种方式的代码具有异常安全性。 -// 无论在函数中的何处拋出异常，都不会阻碍对文件资源的释放。 - -// 地道的C++代码应当把RAII的使用扩展到各种类型的资源上，包括： -// - 用unique_ptr和shared_ptr管理的内存 -// - 各种数据容器，例如标准库中的链表、向量（容量自动扩展的数组）、散列表等； -// 当它们脱离作用域时，析构器会自动释放其中储存的内容。 -// - 用lock_guard和unique_lock实现的互斥 -``` -扩展阅读： - -* [CPP Reference](http://cppreference.com/w/cpp) 提供了最新的语法参考。 -* 可以在 [CPlusPlus](http://cplusplus.com) 找到一些补充资料。 -* 可以在 [TheChernoProject - C ++](https://www.youtube.com/playlist?list=PLlrATfBNZ98dudnM48yfGUldqGD0S4FFb）上找到涵盖语言基础和设置编码环境的教程。 +--- +language: C++ +filename: learncpp-cn.cpp +contributors: + - ["Steven Basart", "http://github.com/xksteven"] + - ["Matt Kline", "https://github.com/mrkline"] +translators: + - ["Arnie97", "https://github.com/Arnie97"] +lang: zh-cn +--- + +C++是一种系统编程语言。用它的发明者， +[Bjarne Stroustrup的话](http://channel9.msdn.com/Events/Lang-NEXT/Lang-NEXT-2014/Keynote)来说，C++的设计目标是： + +- 成为“更好的C语言” +- 支持数据的抽象与封装 +- 支持面向对象编程 +- 支持泛型编程 + +C++提供了对硬件的紧密控制（正如C语言一样）， +能够编译为机器语言，由处理器直接执行。 +与此同时，它也提供了泛型、异常和类等高层功能。 +虽然C++的语法可能比某些出现较晚的语言更复杂，它仍然得到了人们的青睞—— +功能与速度的平衡使C++成为了目前应用最广泛的系统编程语言之一。 + +```c++ +//////////////// +// 与C语言的比较 +//////////////// + +// C++_几乎_是C语言的一个超集，它与C语言的基本语法有许多相同之处， +// 例如变量和函数的声明，原生数据类型等等。 + +// 和C语言一样，在C++中，你的程序会从main()开始执行， +// 该函数的返回值应当为int型，这个返回值会作为程序的退出状态值。 +// 不过，大多数的编译器（gcc，clang等）也接受 void main() 的函数原型。 +// （参见 http://en.wikipedia.org/wiki/Exit_status 来获取更多信息） +int main(int argc, char** argv) +{ + // 和C语言一样，命令行参数通过argc和argv传递。 + // argc代表命令行参数的数量， + // 而argv是一个包含“C语言风格字符串”（char *）的数组， + // 其中每个字符串代表一个命令行参数的内容， + // 首个命令行参数是调用该程序时所使用的名称。 + // 如果你不关心命令行参数的值，argc和argv可以被忽略。 + // 此时，你可以用int main()作为函数原型。 + + // 退出状态值为0时，表示程序执行成功 + return 0; +} + +// 然而，C++和C语言也有一些区别： + +// 在C++中，字符字面量的大小是一个字节。 +sizeof('c') == 1 + +// 在C语言中，字符字面量的大小与int相同。 +sizeof('c') == sizeof(10) + + +// C++的函数原型与函数定义是严格匹配的 +void func(); // 这个函数不能接受任何参数 + +// 而在C语言中 +void func(); // 这个函数能接受任意数量的参数 + +// 在C++中，用nullptr代替C语言中的NULL +int* ip = nullptr; + +// C++也可以使用C语言的标准头文件， +// 但是需要加上前缀“c”并去掉末尾的“.h”。 +#include + +int main() +{ + printf("Hello, world!\n"); + return 0; +} + +/////////// +// 函数重载 +/////////// + +// C++支持函数重载，你可以定义一组名称相同而参数不同的函数。 + +void print(char const* myString) +{ + printf("String %s\n", myString); +} + +void print(int myInt) +{ + printf("My int is %d", myInt); +} + +int main() +{ + print("Hello"); // 解析为 void print(const char*) + print(15); // 解析为 void print(int) +} + +/////////////////// +// 函数参数的默认值 +/////////////////// + +// 你可以为函数的参数指定默认值， +// 它们将会在调用者没有提供相应参数时被使用。 + +void doSomethingWithInts(int a = 1, int b = 4) +{ + // 对两个参数进行一些操作 +} + +int main() +{ + doSomethingWithInts(); // a = 1, b = 4 + doSomethingWithInts(20); // a = 20, b = 4 + doSomethingWithInts(20, 5); // a = 20, b = 5 +} + +// 默认参数必须放在所有的常规参数之后。 + +void invalidDeclaration(int a = 1, int b) // 这是错误的！ +{ +} + + +/////////// +// 命名空间 +/////////// + +// 命名空间为变量、函数和其他声明提供了分离的的作用域。 +// 命名空间可以嵌套使用。 + +namespace First { + namespace Nested { + void foo() + { + printf("This is First::Nested::foo\n"); + } + } // 结束嵌套的命名空间Nested +} // 结束命名空间First + +namespace Second { + void foo() + { + printf("This is Second::foo\n") + } +} + +void foo() +{ + printf("This is global foo\n"); +} + +int main() +{ + // 如果没有特别指定，就从“Second”中取得所需的内容。 + using namespace Second; + + foo(); // 显示“This is Second::foo” + First::Nested::foo(); // 显示“This is First::Nested::foo” + ::foo(); // 显示“This is global foo” +} + +//////////// +// 输入/输出 +//////////// + +// C++使用“流”来输入输出。<<是流的插入运算符，>>是流提取运算符。 +// cin、cout、和cerr分别代表 +// stdin（标准输入）、stdout（标准输出）和stderr（标准错误）。 + +#include // 引入包含输入/输出流的头文件 + +using namespace std; // 输入输出流在std命名空间（也就是标准库）中。 + +int main() +{ + int myInt; + + // 在标准输出（终端/显示器）中显示 + cout << "Enter your favorite number:\n"; + // 从标准输入（键盘）获得一个值 + cin >> myInt; + + // cout也提供了格式化功能 + cout << "Your favorite number is " << myInt << "\n"; + // 显示“Your favorite number is ” + + cerr << "Used for error messages"; +} + +///////// +// 字符串 +///////// + +// C++中的字符串是对象，它们有很多成员函数 +#include + +using namespace std; // 字符串也在std命名空间（标准库）中。 + +string myString = "Hello"; +string myOtherString = " World"; + +// + 可以用于连接字符串。 +cout << myString + myOtherString; // "Hello World" + +cout << myString + " You"; // "Hello You" + +// C++中的字符串是可变的，具有“值语义”。 +myString.append(" Dog"); +cout << myString; // "Hello Dog" + + +///////////// +// 引用 +///////////// + +// 除了支持C语言中的指针类型以外，C++还提供了_引用_。 +// 引用是一种特殊的指针类型，一旦被定义就不能重新赋值，并且不能被设置为空值。 +// 使用引用时的语法与原变量相同： +// 也就是说，对引用类型进行解引用时，不需要使用*； +// 赋值时也不需要用&来取地址。 + +using namespace std; + +string foo = "I am foo"; +string bar = "I am bar"; + + +string& fooRef = foo; // 建立了一个对foo的引用。 +fooRef += ". Hi!"; // 通过引用来修改foo的值 +cout << fooRef; // "I am foo. Hi!" + +// 这句话的并不会改变fooRef的指向，其效果与“foo = bar”相同。 +// 也就是说，在执行这条语句之后，foo == "I am bar"。 +fooRef = bar; + +const string& barRef = bar; // 建立指向bar的常量引用。 +// 和C语言中一样，（指针和引用）声明为常量时，对应的值不能被修改。 +barRef += ". Hi!"; // 这是错误的，不能修改一个常量引用的值。 + +/////////////////// +// 类与面向对象编程 +/////////////////// + +// 有关类的第一个示例 +#include + +// 声明一个类。 +// 类通常在头文件（.h或.hpp）中声明。 +class Dog { + // 成员变量和成员函数默认情况下是私有（private）的。 + std::string name; + int weight; + +// 在这个标签之后，所有声明都是公有（public）的， +// 直到重新指定“private:”（私有继承）或“protected:”（保护继承）为止 +public: + + // 默认的构造器 + Dog(); + + // 这里是成员函数声明的一个例子。 + // 可以注意到，我们在此处使用了std::string，而不是using namespace std + // 语句using namespace绝不应当出现在头文件当中。 + void setName(const std::string& dogsName); + + void setWeight(int dogsWeight); + + // 如果一个函数不对对象的状态进行修改， + // 应当在声明中加上const。 + // 这样，你就可以对一个以常量方式引用的对象执行该操作。 + // 同时可以注意到，当父类的成员函数需要被子类重写时， + // 父类中的函数必须被显式声明为_虚函数（virtual）_。 + // 考虑到性能方面的因素，函数默认情况下不会被声明为虚函数。 + virtual void print() const; + + // 函数也可以在class body内部定义。 + // 这样定义的函数会自动成为内联函数。 + void bark() const { std::cout << name << " barks!\n" } + + // 除了构造器以外，C++还提供了析构器。 + // 当一个对象被删除或者脱离其定义域时，它的析构函数会被调用。 + // 这使得RAII这样的强大范式（参见下文）成为可能。 + // 为了衍生出子类来，基类的析构函数必须定义为虚函数。 + virtual ~Dog(); + +}; // 在类的定义之后，要加一个分号 + +// 类的成员函数通常在.cpp文件中实现。 +void Dog::Dog() +{ + std::cout << "A dog has been constructed\n"; +} + +// 对象（例如字符串）应当以引用的形式传递， +// 对于不需要修改的对象，最好使用常量引用。 +void Dog::setName(const std::string& dogsName) +{ + name = dogsName; +} + +void Dog::setWeight(int dogsWeight) +{ + weight = dogsWeight; +} + +// 虚函数的virtual关键字只需要在声明时使用，不需要在定义时重复 +void Dog::print() const +{ + std::cout << "Dog is " << name << " and weighs " << weight << "kg\n"; +} + +void Dog::~Dog() +{ + std::cout << "Goodbye " << name << "\n"; +} + +int main() { + Dog myDog; // 此时显示“A dog has been constructed” + myDog.setName("Barkley"); + myDog.setWeight(10); + myDog.print(); // 显示“Dog is Barkley and weighs 10 kg” + return 0; +} // 显示“Goodbye Barkley” + +// 继承： + +// 这个类继承了Dog类中的公有（public）和保护（protected）对象 +class OwnedDog : public Dog { + + void setOwner(const std::string& dogsOwner) + + // 重写OwnedDogs类的print方法。 + // 如果你不熟悉子类多态的话，可以参考这个页面中的概述： + // http://zh.wikipedia.org/wiki/%E5%AD%90%E7%B1%BB%E5%9E%8B + + // override关键字是可选的，它确保你所重写的是基类中的方法。 + void print() const override; + +private: + std::string owner; +}; + +// 与此同时，在对应的.cpp文件里： + +void OwnedDog::setOwner(const std::string& dogsOwner) +{ + owner = dogsOwner; +} + +void OwnedDog::print() const +{ + Dog::print(); // 调用基类Dog中的print方法 + // "Dog is and weights " + + std::cout << "Dog is owned by " << owner << "\n"; + // "Dog is owned by " +} + +///////////////////// +// 初始化与运算符重载 +///////////////////// + +// 在C++中，通过定义一些特殊名称的函数， +// 你可以重载+、-、*、/等运算符的行为。 +// 当运算符被使用时，这些特殊函数会被调用，从而实现运算符重载。 + +#include +using namespace std; + +class Point { +public: + // 可以以这样的方式为成员变量设置默认值。 + double x = 0; + double y = 0; + + // 定义一个默认的构造器。 + // 除了将Point初始化为(0, 0)以外，这个函数什么都不做。 + Point() { }; + + // 下面使用的语法称为初始化列表， + // 这是初始化类中成员变量的正确方式。 + Point (double a, double b) : + x(a), + y(b) + { /* 除了初始化成员变量外，什么都不做 */ } + + // 重载 + 运算符 + Point operator+(const Point& rhs) const; + + // 重载 += 运算符 + Point& operator+=(const Point& rhs); + + // 增加 - 和 -= 运算符也是有意义的，但这里不再赘述。 +}; + +Point Point::operator+(const Point& rhs) const +{ + // 创建一个新的点， + // 其横纵坐标分别为这个点与另一点在对应方向上的坐标之和。 + return Point(x + rhs.x, y + rhs.y); +} + +Point& Point::operator+=(const Point& rhs) +{ + x += rhs.x; + y += rhs.y; + return *this; +} + +int main () { + Point up (0,1); + Point right (1,0); + // 这里使用了Point类型的运算符“+” + // 调用up（Point类型）的“+”方法，并以right作为函数的参数 + Point result = up + right; + // 显示“Result is upright (1,1)” + cout << "Result is upright (" << result.x << ',' << result.y << ")\n"; + return 0; +} + +/////////// +// 异常处理 +/////////// + +// 标准库中提供了一些基本的异常类型 +// （参见http://en.cppreference.com/w/cpp/error/exception） +// 但是，其他任何类型也可以作为一个异常被拋出 +#include + +// 在_try_代码块中拋出的异常可以被随后的_catch_捕获。 +try { + // 不要用 _new_关键字在堆上为异常分配空间。 + throw std::exception("A problem occurred"); +} +// 如果拋出的异常是一个对象，可以用常量引用来捕获它 +catch (const std::exception& ex) +{ + std::cout << ex.what(); +// 捕获尚未被_catch_处理的所有错误 +} catch (...) +{ + std::cout << "Unknown exception caught"; + throw; // 重新拋出异常 +} + +/////// +// RAII +/////// + +// RAII指的是“资源获取就是初始化”（Resource Allocation Is Initialization）， +// 它被视作C++中最强大的编程范式之一。 +// 简单说来，它指的是，用构造函数来获取一个对象的资源， +// 相应的，借助析构函数来释放对象的资源。 + +// 为了理解这一范式的用处，让我们考虑某个函数使用文件句柄时的情况： +void doSomethingWithAFile(const char* filename) +{ + // 首先，让我们假设一切都会顺利进行。 + + FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 + + doSomethingWithTheFile(fh); + doSomethingElseWithIt(fh); + + fclose(fh); // 关闭文件句柄 +} + +// 不幸的是，随着错误处理机制的引入，事情会变得复杂。 +// 假设fopen函数有可能执行失败， +// 而doSomethingWithTheFile和doSomethingElseWithIt会在失败时返回错误代码。 +// （虽然异常是C++中处理错误的推荐方式， +// 但是某些程序员，尤其是有C语言背景的，并不认可异常捕获机制的作用）。 +// 现在，我们必须检查每个函数调用是否成功执行，并在问题发生的时候关闭文件句柄。 +bool doSomethingWithAFile(const char* filename) +{ + FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 + if (fh == nullptr) // 当执行失败是，返回的指针是nullptr + return false; // 向调用者汇报错误 + + // 假设每个函数会在执行失败时返回false + if (!doSomethingWithTheFile(fh)) { + fclose(fh); // 关闭文件句柄，避免造成内存泄漏。 + return false; // 反馈错误 + } + if (!doSomethingElseWithIt(fh)) { + fclose(fh); // 关闭文件句柄 + return false; // 反馈错误 + } + + fclose(fh); // 关闭文件句柄 + return true; // 指示函数已成功执行 +} + +// C语言的程序员通常会借助goto语句简化上面的代码： +bool doSomethingWithAFile(const char* filename) +{ + FILE* fh = fopen(filename, "r"); + if (fh == nullptr) + return false; + + if (!doSomethingWithTheFile(fh)) + goto failure; + + if (!doSomethingElseWithIt(fh)) + goto failure; + + fclose(fh); // 关闭文件 + return true; // 执行成功 + +failure: + fclose(fh); + return false; // 反馈错误 +} + +// 如果用异常捕获机制来指示错误的话， +// 代码会变得清晰一些，但是仍然有优化的余地。 +void doSomethingWithAFile(const char* filename) +{ + FILE* fh = fopen(filename, "r"); // 以只读模式打开文件 + if (fh == nullptr) + throw std::exception("Could not open the file."); + + try { + doSomethingWithTheFile(fh); + doSomethingElseWithIt(fh); + } + catch (...) { + fclose(fh); // 保证出错的时候文件被正确关闭 + throw; // 之后，重新抛出这个异常 + } + + fclose(fh); // 关闭文件 + // 所有工作顺利完成 +} + +// 相比之下，使用C++中的文件流类（fstream）时， +// fstream会利用自己的析构器来关闭文件句柄。 +// 只要离开了某一对象的定义域，它的析构函数就会被自动调用。 +void doSomethingWithAFile(const std::string& filename) +{ + // ifstream是输入文件流（input file stream）的简称 + std::ifstream fh(filename); // 打开一个文件 + + // 对文件进行一些操作 + doSomethingWithTheFile(fh); + doSomethingElseWithIt(fh); + +} // 文件已经被析构器自动关闭 + +// 与上面几种方式相比，这种方式有着_明显_的优势： +// 1. 无论发生了什么情况，资源（此例当中是文件句柄）都会被正确关闭。 +// 只要你正确使用了析构器，就_不会_因为忘记关闭句柄，造成资源的泄漏。 +// 2. 可以注意到，通过这种方式写出来的代码十分简洁。 +// 析构器会在后台关闭文件句柄，不再需要你来操心这些琐事。 +// 3. 这种方式的代码具有异常安全性。 +// 无论在函数中的何处拋出异常，都不会阻碍对文件资源的释放。 + +// 地道的C++代码应当把RAII的使用扩展到各种类型的资源上，包括： +// - 用unique_ptr和shared_ptr管理的内存 +// - 各种数据容器，例如标准库中的链表、向量（容量自动扩展的数组）、散列表等； +// 当它们脱离作用域时，析构器会自动释放其中储存的内容。 +// - 用lock_guard和unique_lock实现的互斥 +``` +扩展阅读： + +* [CPP Reference](http://cppreference.com/w/cpp) 提供了最新的语法参考。 +* 可以在 [CPlusPlus](http://cplusplus.com) 找到一些补充资料。 +* 可以在 [TheChernoProject - C ++](https://www.youtube.com/playlist?list=PLlrATfBNZ98dudnM48yfGUldqGD0S4FFb）上找到涵盖语言基础和设置编码环境的教程。 diff --git a/zh-cn/elisp-cn.html.markdown b/zh-cn/elisp-cn.html.markdown index 3f6ccbcf..a429fcbc 100644 --- a/zh-cn/elisp-cn.html.markdown +++ b/zh-cn/elisp-cn.html.markdown @@ -1,345 +1,345 @@ ---- -language: elisp -contributors: - - ["Bastien Guerry", "http://bzg.fr"] -translators: - - ["Chenbo Li", "http://binarythink.net"] -filename: learn-emacs-lisp-zh.el -lang: zh-cn ---- - -```scheme -;; 15分钟学会Emacs Lisp (v0.2a) -;;（作者：bzg，https://github.com/bzg -;; 译者：lichenbo，http://douban.com/people/lichenbo） -;; -;; 请先阅读Peter Norvig的一篇好文: -;; http://norvig.com/21-days.html -;; （译者注：中文版请见http://blog.youxu.info/21-days/） -;; -;; 之后安装GNU Emacs 24.3: -;; -;; Debian: apt-get install emacs (视具体发行版而定) -;; MacOSX: http://emacsformacosx.com/emacs-builds/Emacs-24.3-universal-10.6.8.dmg -;; Windows: http://ftp.gnu.org/gnu/windows/emacs/emacs-24.3-bin-i386.zip -;; -;; 更多信息可以在这里找到: -;; http://www.gnu.org/software/emacs/#Obtaining - -;; 很重要的警告: -;; -;; 按照这个教程来学习并不会对你的电脑有任何损坏 -;; 除非你自己在学习的过程中愤怒地把它砸了 -;; 如果出现了这种情况，我不会承担任何责任 -;; -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; -;; 打开emacs -;; -;; 按'q'消除欢迎界面 -;; -;; 现在请注意窗口底部的那一个灰色长条 -;; -;; "*scratch*" 是你现在编辑界面的名字。 -;; 这个编辑界面叫做一个"buffer"。 -;; -;; 每当你打开Emacs时，都会默认打开这个scratch buffer -;; 此时你并没有在编辑任何文件，而是在编辑一个buffer -;; 之后你可以将这个buffer保存到一个文件中。 -;; -;; 之后的"Lisp interaction" 则是表明我们可以用的某组命令 -;; -;; Emacs在每个buffer中都有一组内置的命令 -;; 而当你激活某种特定的模式时，就可以使用相应的命令 -;; 这里我们使用`lisp-interaction-mode'， -;; 这样我们就可以使用内置的Emacs Lisp（以下简称Elisp）命令了。 - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; -;; 分号是注释开始的标志 -;; -;; Elisp 是由符号表达式构成的 (即"s-表达式"或"s式"): -(+ 2 2) - -;; 这个s式的意思是 "对2进行加2操作". - -;; s式周围有括号，而且也可以嵌套: -(+ 2 (+ 1 1)) - -;; 一个s式可以包含原子符号或者其他s式 -;; 在上面的例子中，1和2是原子符号 -;; (+ 2 (+ 1 1)) 和 (+ 1 1) 是s式. - -;; 在 `lisp-interaction-mode' 中你可以计算s式. -;; 把光标移到闭括号后，之后按下ctrl+j（以后简写为'C-j'） - -(+ 3 (+ 1 2)) -;; ^ 光标放到这里 -;; 按下`C-j' 就会输出 6 - -;; `C-j' 会在buffer中插入当前运算的结果 - -;; 而`C-xC-e' 则会在emacs最底部显示结果，也就是被称作"minibuffer"的区域 -;; 为了避免把我们的buffer填满无用的结果，我们以后会一直用`C-xC-e' - -;; `setq' 可以将一个值赋给一个变量 -(setq my-name "Bastien") -;; `C-xC-e' 输出 "Bastien" (在 mini-buffer 中显示) - -;; `insert' 会在光标处插入字符串: -(insert "Hello!") -;; `C-xC-e' 输出 "Hello!" - -;; 在这里我们只传给了insert一个参数"Hello!", 但是 -;; 我们也可以传给它更多的参数，比如2个： - -(insert "Hello" " world!") -;; `C-xC-e' 输出 "Hello world!" - -;; 你也可以用变量名来代替字符串 -(insert "Hello, I am " my-name) -;; `C-xC-e' 输出 "Hello, I am Bastien" - -;; 你可以把s式嵌入函数中 -(defun hello () (insert "Hello, I am " my-name)) -;; `C-xC-e' 输出 hello - -;; 现在执行这个函数 -(hello) -;; `C-xC-e' 输出 Hello, I am Bastien - -;; 函数中空括号的意思是我们不需要接受任何参数 -;; 但是我们不能一直总是用my-name这个变量 -;; 所以我们现在使我们的函数接受一个叫做"name"的参数 - -(defun hello (name) (insert "Hello " name)) -;; `C-xC-e' 输出 hello - -;; 现在我们调用这个函数，并且将"you"作为参数传递 - -(hello "you") -;; `C-xC-e' 输出 "Hello you" - -;; 成功！ - -;; 现在我们可以休息一下 - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; -;; 下面我们在新的窗口中新建一个名为 "*test*" 的buffer: - -(switch-to-buffer-other-window "*test*") -;; `C-xC-e' 这时屏幕上会显示两个窗口，而光标此时位于*test* buffer内 - -;; 用鼠标单击上面的buffer就会使光标移回。 -;; 或者你可以使用 `C-xo' 使得光标跳到另一个窗口中 - -;; 你可以用 `progn'命令将s式结合起来: -(progn - (switch-to-buffer-other-window "*test*") - (hello "you")) -;; `C-xC-e' 此时屏幕分为两个窗口，并且在*test* buffer中显示"Hello you" - -;; 现在为了简洁，我们需要在每个s式后面都使用`C-xC-e'来执行，后面就不再说明了 - -;; 记得可以用过鼠标或者`C-xo'回到*scratch*这个buffer。 - -;; 清除当前buffer也是常用操作之一： -(progn - (switch-to-buffer-other-window "*test*") - (erase-buffer) - (hello "there")) - -;; 也可以回到其他的窗口中 -(progn - (switch-to-buffer-other-window "*test*") - (erase-buffer) - (hello "you") - (other-window 1)) - -;; 你可以用 `let' 将一个值和一个局部变量绑定: -(let ((local-name "you")) - (switch-to-buffer-other-window "*test*") - (erase-buffer) - (hello local-name) - (other-window 1)) - -;; 这里我们就不需要使用 `progn' 了， 因为 `let' 也可以将很多s式组合起来。 - -;; 格式化字符串的方法： -(format "Hello %s!\n" "visitor") - -;; %s 是字符串占位符，这里被"visitor"替代. -;; \n 是换行符。 - -;; 现在我们用格式化的方法再重写一下我们的函数: -(defun hello (name) - (insert (format "Hello %s!\n" name))) - -(hello "you") - -;; 我们再用`let'新建另一个函数: -(defun greeting (name) - (let ((your-name "Bastien")) - (insert (format "Hello %s!\n\nI am %s." - name ; the argument of the function - your-name ; the let-bound variable "Bastien" - )))) - -;; 之后执行: -(greeting "you") - -;; 有些函数可以和用户交互: -(read-from-minibuffer "Enter your name: ") - -;; 这个函数会返回在执行时用户输入的信息 - -;; 现在我们让`greeting'函数显示你的名字: -(defun greeting (from-name) - (let ((your-name (read-from-minibuffer "Enter your name: "))) - (insert (format "Hello!\n\nI am %s and you are %s." - from-name ; the argument of the function - your-name ; the let-bound var, entered at prompt - )))) - -(greeting "Bastien") - -;; 我们让结果在另一个窗口中显示: -(defun greeting (from-name) - (let ((your-name (read-from-minibuffer "Enter your name: "))) - (switch-to-buffer-other-window "*test*") - (erase-buffer) - (insert (format "Hello %s!\n\nI am %s." your-name from-name)) - (other-window 1))) - -;; 测试一下： -(greeting "Bastien") - -;; 第二节结束，休息一下吧。 - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; -;; 我们将一些名字存到列表中： -(setq list-of-names '("Sarah" "Chloe" "Mathilde")) - -;; 用 `car'来取得第一个名字： -(car list-of-names) - -;; 用 `cdr'取得剩下的名字: -(cdr list-of-names) - -;; 用 `push'把名字添加到列表的开头: -(push "Stephanie" list-of-names) - -;; 注意: `car' 和 `cdr' 并不修改列表本身, 但是 `push' 却会对列表本身进行操作. -;; 这个区别是很重要的: 有些函数没有任何副作用（比如`car'） -;; 但还有一些却是有的 (比如 `push'). - -;; 我们来对`list-of-names'列表中的每一个元素都使用hello函数: -(mapcar 'hello list-of-names) - -;; 将 `greeting' 改进，使的我们能够对`list-of-names'中的所有名字执行: -(defun greeting () - (switch-to-buffer-other-window "*test*") - (erase-buffer) - (mapcar 'hello list-of-names) - (other-window 1)) - -(greeting) - -;; 记得我们之前定义的 `hello' 函数吗？ 这个函数接受一个参数，名字。 -;; `mapcar' 调用 `hello', 并将`list-of-names'作为参数先后传给`hello' - -;; 现在我们对显示的buffer中的内容进行一些更改： - -(defun replace-hello-by-bonjour () - (switch-to-buffer-other-window "*test*") - (goto-char (point-min)) - (while (search-forward "Hello") - (replace-match "Bonjour")) - (other-window 1)) - -;; (goto-char (point-min)) 将光标移到buffer的开始 -;; (search-forward "Hello") 查找字符串"Hello" -;; (while x y) 当x返回某个值时执行y这个s式 -;; 当x返回`nil' (空), 退出循环 - -(replace-hello-by-bonjour) - -;; 你会看到所有在*test* buffer中出现的"Hello"字样都被换成了"Bonjour" - -;; 你也会得到以下错误提示: "Search failed: Hello". -;; -;; 如果要避免这个错误, 你需要告诉 `search-forward' 这个命令是否在 -;; buffer的某个地方停止查找, 并且在什么都没找到时是否应该不给出错误提示 - -;; (search-forward "Hello" nil t) 可以达到这个要求: - -;; `nil' 参数的意思是 : 查找并不限于某个范围内 -;; `t' 参数的意思是: 当什么都没找到时，不给出错误提示 - -;; 在下面的函数中，我们用到了s式，并且不给出任何错误提示: - -(defun hello-to-bonjour () - (switch-to-buffer-other-window "*test*") - (erase-buffer) - ;; 为`list-of-names'中的每个名字调用hello - (mapcar 'hello list-of-names) - (goto-char (point-min)) - ;; 将"Hello" 替换为"Bonjour" - (while (search-forward "Hello" nil t) - (replace-match "Bonjour")) - (other-window 1)) - -(hello-to-bonjour) - -;; 给这些名字加粗: - -(defun boldify-names () - (switch-to-buffer-other-window "*test*") - (goto-char (point-min)) - (while (re-search-forward "Bonjour \\(.+\\)!" nil t) - (add-text-properties (match-beginning 1) - (match-end 1) - (list 'face 'bold))) - (other-window 1)) - -;; 这个函数使用了 `re-search-forward': -;; 和查找一个字符串不同，你用这个命令可以查找一个模式，即正则表达式 - -;; 正则表达式 "Bonjour \\(.+\\)!" 的意思是: -;; 字符串 "Bonjour ", 之后跟着 -;; 一组 | \\( ... \\) 结构 -;; 任意字符 | . 的含义 -;; 有可能重复的 | + 的含义 -;; 之后跟着 "!" 这个字符串 - -;; 准备好了？试试看。 - -(boldify-names) - -;; `add-text-properties' 可以添加文字属性, 比如文字样式 - -;; 好的，我们成功了！ - -;; 如果你想对一个变量或者函数有更多的了解： -;; -;; C-h v 变量 回车 -;; C-h f 函数 回车 -;; -;; 阅读Emacs Lisp官方文档: -;; -;; C-h i m elisp 回车 -;; -;; 在线阅读Emacs Lisp文档: -;; https://www.gnu.org/software/emacs/manual/html_node/eintr/index.html - -;; 感谢以下同学的建议和反馈: -;; - Wes Hardaker -;; - notbob -;; - Kevin Montuori -;; - Arne Babenhauserheide -;; - Alan Schmitt -;; - spacegoing -``` - +--- +language: elisp +contributors: + - ["Bastien Guerry", "http://bzg.fr"] +translators: + - ["Chenbo Li", "http://binarythink.net"] +filename: learn-emacs-lisp-zh.el +lang: zh-cn +--- + +```scheme +;; 15分钟学会Emacs Lisp (v0.2a) +;;（作者：bzg，https://github.com/bzg +;; 译者：lichenbo，http://douban.com/people/lichenbo） +;; +;; 请先阅读Peter Norvig的一篇好文: +;; http://norvig.com/21-days.html +;; （译者注：中文版请见http://blog.youxu.info/21-days/） +;; +;; 之后安装GNU Emacs 24.3: +;; +;; Debian: apt-get install emacs (视具体发行版而定) +;; MacOSX: http://emacsformacosx.com/emacs-builds/Emacs-24.3-universal-10.6.8.dmg +;; Windows: http://ftp.gnu.org/gnu/windows/emacs/emacs-24.3-bin-i386.zip +;; +;; 更多信息可以在这里找到: +;; http://www.gnu.org/software/emacs/#Obtaining + +;; 很重要的警告: +;; +;; 按照这个教程来学习并不会对你的电脑有任何损坏 +;; 除非你自己在学习的过程中愤怒地把它砸了 +;; 如果出现了这种情况，我不会承担任何责任 +;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; +;; 打开emacs +;; +;; 按'q'消除欢迎界面 +;; +;; 现在请注意窗口底部的那一个灰色长条 +;; +;; "*scratch*" 是你现在编辑界面的名字。 +;; 这个编辑界面叫做一个"buffer"。 +;; +;; 每当你打开Emacs时，都会默认打开这个scratch buffer +;; 此时你并没有在编辑任何文件，而是在编辑一个buffer +;; 之后你可以将这个buffer保存到一个文件中。 +;; +;; 之后的"Lisp interaction" 则是表明我们可以用的某组命令 +;; +;; Emacs在每个buffer中都有一组内置的命令 +;; 而当你激活某种特定的模式时，就可以使用相应的命令 +;; 这里我们使用`lisp-interaction-mode'， +;; 这样我们就可以使用内置的Emacs Lisp（以下简称Elisp）命令了。 + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; +;; 分号是注释开始的标志 +;; +;; Elisp 是由符号表达式构成的 (即"s-表达式"或"s式"): +(+ 2 2) + +;; 这个s式的意思是 "对2进行加2操作". + +;; s式周围有括号，而且也可以嵌套: +(+ 2 (+ 1 1)) + +;; 一个s式可以包含原子符号或者其他s式 +;; 在上面的例子中，1和2是原子符号 +;; (+ 2 (+ 1 1)) 和 (+ 1 1) 是s式. + +;; 在 `lisp-interaction-mode' 中你可以计算s式. +;; 把光标移到闭括号后，之后按下ctrl+j（以后简写为'C-j'） + +(+ 3 (+ 1 2)) +;; ^ 光标放到这里 +;; 按下`C-j' 就会输出 6 + +;; `C-j' 会在buffer中插入当前运算的结果 + +;; 而`C-xC-e' 则会在emacs最底部显示结果，也就是被称作"minibuffer"的区域 +;; 为了避免把我们的buffer填满无用的结果，我们以后会一直用`C-xC-e' + +;; `setq' 可以将一个值赋给一个变量 +(setq my-name "Bastien") +;; `C-xC-e' 输出 "Bastien" (在 mini-buffer 中显示) + +;; `insert' 会在光标处插入字符串: +(insert "Hello!") +;; `C-xC-e' 输出 "Hello!" + +;; 在这里我们只传给了insert一个参数"Hello!", 但是 +;; 我们也可以传给它更多的参数，比如2个： + +(insert "Hello" " world!") +;; `C-xC-e' 输出 "Hello world!" + +;; 你也可以用变量名来代替字符串 +(insert "Hello, I am " my-name) +;; `C-xC-e' 输出 "Hello, I am Bastien" + +;; 你可以把s式嵌入函数中 +(defun hello () (insert "Hello, I am " my-name)) +;; `C-xC-e' 输出 hello + +;; 现在执行这个函数 +(hello) +;; `C-xC-e' 输出 Hello, I am Bastien + +;; 函数中空括号的意思是我们不需要接受任何参数 +;; 但是我们不能一直总是用my-name这个变量 +;; 所以我们现在使我们的函数接受一个叫做"name"的参数 + +(defun hello (name) (insert "Hello " name)) +;; `C-xC-e' 输出 hello + +;; 现在我们调用这个函数，并且将"you"作为参数传递 + +(hello "you") +;; `C-xC-e' 输出 "Hello you" + +;; 成功！ + +;; 现在我们可以休息一下 + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; +;; 下面我们在新的窗口中新建一个名为 "*test*" 的buffer: + +(switch-to-buffer-other-window "*test*") +;; `C-xC-e' 这时屏幕上会显示两个窗口，而光标此时位于*test* buffer内 + +;; 用鼠标单击上面的buffer就会使光标移回。 +;; 或者你可以使用 `C-xo' 使得光标跳到另一个窗口中 + +;; 你可以用 `progn'命令将s式结合起来: +(progn + (switch-to-buffer-other-window "*test*") + (hello "you")) +;; `C-xC-e' 此时屏幕分为两个窗口，并且在*test* buffer中显示"Hello you" + +;; 现在为了简洁，我们需要在每个s式后面都使用`C-xC-e'来执行，后面就不再说明了 + +;; 记得可以用过鼠标或者`C-xo'回到*scratch*这个buffer。 + +;; 清除当前buffer也是常用操作之一： +(progn + (switch-to-buffer-other-window "*test*") + (erase-buffer) + (hello "there")) + +;; 也可以回到其他的窗口中 +(progn + (switch-to-buffer-other-window "*test*") + (erase-buffer) + (hello "you") + (other-window 1)) + +;; 你可以用 `let' 将一个值和一个局部变量绑定: +(let ((local-name "you")) + (switch-to-buffer-other-window "*test*") + (erase-buffer) + (hello local-name) + (other-window 1)) + +;; 这里我们就不需要使用 `progn' 了， 因为 `let' 也可以将很多s式组合起来。 + +;; 格式化字符串的方法： +(format "Hello %s!\n" "visitor") + +;; %s 是字符串占位符，这里被"visitor"替代. +;; \n 是换行符。 + +;; 现在我们用格式化的方法再重写一下我们的函数: +(defun hello (name) + (insert (format "Hello %s!\n" name))) + +(hello "you") + +;; 我们再用`let'新建另一个函数: +(defun greeting (name) + (let ((your-name "Bastien")) + (insert (format "Hello %s!\n\nI am %s." + name ; the argument of the function + your-name ; the let-bound variable "Bastien" + )))) + +;; 之后执行: +(greeting "you") + +;; 有些函数可以和用户交互: +(read-from-minibuffer "Enter your name: ") + +;; 这个函数会返回在执行时用户输入的信息 + +;; 现在我们让`greeting'函数显示你的名字: +(defun greeting (from-name) + (let ((your-name (read-from-minibuffer "Enter your name: "))) + (insert (format "Hello!\n\nI am %s and you are %s." + from-name ; the argument of the function + your-name ; the let-bound var, entered at prompt + )))) + +(greeting "Bastien") + +;; 我们让结果在另一个窗口中显示: +(defun greeting (from-name) + (let ((your-name (read-from-minibuffer "Enter your name: "))) + (switch-to-buffer-other-window "*test*") + (erase-buffer) + (insert (format "Hello %s!\n\nI am %s." your-name from-name)) + (other-window 1))) + +;; 测试一下： +(greeting "Bastien") + +;; 第二节结束，休息一下吧。 + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; +;; 我们将一些名字存到列表中： +(setq list-of-names '("Sarah" "Chloe" "Mathilde")) + +;; 用 `car'来取得第一个名字： +(car list-of-names) + +;; 用 `cdr'取得剩下的名字: +(cdr list-of-names) + +;; 用 `push'把名字添加到列表的开头: +(push "Stephanie" list-of-names) + +;; 注意: `car' 和 `cdr' 并不修改列表本身, 但是 `push' 却会对列表本身进行操作. +;; 这个区别是很重要的: 有些函数没有任何副作用（比如`car'） +;; 但还有一些却是有的 (比如 `push'). + +;; 我们来对`list-of-names'列表中的每一个元素都使用hello函数: +(mapcar 'hello list-of-names) + +;; 将 `greeting' 改进，使的我们能够对`list-of-names'中的所有名字执行: +(defun greeting () + (switch-to-buffer-other-window "*test*") + (erase-buffer) + (mapcar 'hello list-of-names) + (other-window 1)) + +(greeting) + +;; 记得我们之前定义的 `hello' 函数吗？ 这个函数接受一个参数，名字。 +;; `mapcar' 调用 `hello', 并将`list-of-names'作为参数先后传给`hello' + +;; 现在我们对显示的buffer中的内容进行一些更改： + +(defun replace-hello-by-bonjour () + (switch-to-buffer-other-window "*test*") + (goto-char (point-min)) + (while (search-forward "Hello") + (replace-match "Bonjour")) + (other-window 1)) + +;; (goto-char (point-min)) 将光标移到buffer的开始 +;; (search-forward "Hello") 查找字符串"Hello" +;; (while x y) 当x返回某个值时执行y这个s式 +;; 当x返回`nil' (空), 退出循环 + +(replace-hello-by-bonjour) + +;; 你会看到所有在*test* buffer中出现的"Hello"字样都被换成了"Bonjour" + +;; 你也会得到以下错误提示: "Search failed: Hello". +;; +;; 如果要避免这个错误, 你需要告诉 `search-forward' 这个命令是否在 +;; buffer的某个地方停止查找, 并且在什么都没找到时是否应该不给出错误提示 + +;; (search-forward "Hello" nil t) 可以达到这个要求: + +;; `nil' 参数的意思是 : 查找并不限于某个范围内 +;; `t' 参数的意思是: 当什么都没找到时，不给出错误提示 + +;; 在下面的函数中，我们用到了s式，并且不给出任何错误提示: + +(defun hello-to-bonjour () + (switch-to-buffer-other-window "*test*") + (erase-buffer) + ;; 为`list-of-names'中的每个名字调用hello + (mapcar 'hello list-of-names) + (goto-char (point-min)) + ;; 将"Hello" 替换为"Bonjour" + (while (search-forward "Hello" nil t) + (replace-match "Bonjour")) + (other-window 1)) + +(hello-to-bonjour) + +;; 给这些名字加粗: + +(defun boldify-names () + (switch-to-buffer-other-window "*test*") + (goto-char (point-min)) + (while (re-search-forward "Bonjour \\(.+\\)!" nil t) + (add-text-properties (match-beginning 1) + (match-end 1) + (list 'face 'bold))) + (other-window 1)) + +;; 这个函数使用了 `re-search-forward': +;; 和查找一个字符串不同，你用这个命令可以查找一个模式，即正则表达式 + +;; 正则表达式 "Bonjour \\(.+\\)!" 的意思是: +;; 字符串 "Bonjour ", 之后跟着 +;; 一组 | \\( ... \\) 结构 +;; 任意字符 | . 的含义 +;; 有可能重复的 | + 的含义 +;; 之后跟着 "!" 这个字符串 + +;; 准备好了？试试看。 + +(boldify-names) + +;; `add-text-properties' 可以添加文字属性, 比如文字样式 + +;; 好的，我们成功了！ + +;; 如果你想对一个变量或者函数有更多的了解： +;; +;; C-h v 变量 回车 +;; C-h f 函数 回车 +;; +;; 阅读Emacs Lisp官方文档: +;; +;; C-h i m elisp 回车 +;; +;; 在线阅读Emacs Lisp文档: +;; https://www.gnu.org/software/emacs/manual/html_node/eintr/index.html + +;; 感谢以下同学的建议和反馈: +;; - Wes Hardaker +;; - notbob +;; - Kevin Montuori +;; - Arne Babenhauserheide +;; - Alan Schmitt +;; - spacegoing +``` + diff --git a/zh-cn/matlab-cn.html.markdown b/zh-cn/matlab-cn.html.markdown index ca08b36b..bb1ab79a 100644 --- a/zh-cn/matlab-cn.html.markdown +++ b/zh-cn/matlab-cn.html.markdown @@ -1,504 +1,504 @@ ---- -language: MATLAB -filename: matlab-cn.m -contributors: - - ["mendozao", "http://github.com/mendozao"] - - ["jamesscottbrown", "http://jamesscottbrown.com"] -translators: - - ["sunxb10", "https://github.com/sunxb10"] -lang: zh-cn - ---- - -MATLAB 是 MATrix LABoratory（矩阵实验室）的缩写。 -它是一种功能强大的数值计算语言，在工程和数学领域中应用广泛。 - -如果您有任何需要反馈或交流的内容，请联系本教程作者： -[@the_ozzinator](https://twitter.com/the_ozzinator) -或 [osvaldo.t.mendoza@gmail.com](mailto:osvaldo.t.mendoza@gmail.com)。 - -```matlab -% 以百分号作为注释符 - -%{ -多行注释 -可以 -这样 -表示 -%} - -% 指令可以随意跨行，但需要在跨行处用 '...' 标明： - a = 1 + 2 + ... - + 4 - -% 可以在MATLAB中直接向操作系统发出指令 -!ping google.com - -who % 显示内存中的所有变量 -whos % 显示内存中的所有变量以及它们的类型 -clear % 清除内存中的所有变量 -clear('A') % 清除指定的变量 -openvar('A') % 在变量编辑器中编辑指定变量 - -clc % 清除命令窗口中显示的所有指令 -diary % 将命令窗口中的内容写入本地文件 -ctrl-c % 终止当前计算 - -edit('myfunction.m') % 在编辑器中打开指定函数或脚本 -type('myfunction.m') % 在命令窗口中打印指定函数或脚本的源码 - -profile on % 打开 profile 代码分析工具 -profile off % 关闭 profile 代码分析工具 -profile viewer % 查看 profile 代码分析工具的分析结果 - -help command % 在命令窗口中显示指定命令的帮助文档 -doc command % 在帮助窗口中显示指定命令的帮助文档 -lookfor command % 在所有 MATLAB 内置函数的头部注释块的第一行中搜索指定命令 -lookfor command -all % 在所有 MATLAB 内置函数的整个头部注释块中搜索指定命令 - - -% 输出格式 -format short % 浮点数保留 4 位小数 -format long % 浮点数保留 15 位小数 -format bank % 金融格式，浮点数只保留 2 位小数 -fprintf('text') % 在命令窗口中显示 "text" -disp('text') % 在命令窗口中显示 "text" - - -% 变量与表达式 -myVariable = 4 % 命令窗口中将新创建的变量 -myVariable = 4; % 加上分号可使命令窗口中不显示当前语句执行结果 -4 + 6 % ans = 10 -8 * myVariable % ans = 32 -2 ^ 3 % ans = 8 -a = 2; b = 3; -c = exp(a)*sin(pi/2) % c = 7.3891 - - -% 调用函数有两种方式： -% 标准函数语法： -load('myFile.mat', 'y') % 参数放在括号内，以英文逗号分隔 -% 指令语法: -load myFile.mat y % 不加括号，以空格分隔参数 -% 注意在指令语法中参数不需要加引号：在这种语法下，所有输入参数都只能是文本文字， -% 不能是变量的具体值，同样也不能是输出变量 -[V,D] = eig(A); % 这条函数调用无法转换成等价的指令语法 -[~,D] = eig(A); % 如果结果中只需要 D 而不需要 V 则可以这样写 - - - -% 逻辑运算 -1 > 5 % 假，ans = 0 -10 >= 10 % 真，ans = 1 -3 ~= 4 % 不等于 -> ans = 1 -3 == 3 % 等于 -> ans = 1 -3 > 1 && 4 > 1 % 与 -> ans = 1 -3 > 1 || 4 > 1 % 或 -> ans = 1 -~1 % 非 -> ans = 0 - -% 逻辑运算可直接应用于矩阵，运算结果也是矩阵 -A > 5 -% 对矩阵中每个元素做逻辑运算，若为真，则在运算结果的矩阵中对应位置的元素就是 1 -A( A > 5 ) -% 如此返回的向量，其元素就是 A 矩阵中所有逻辑运算为真的元素 - -% 字符串 -a = 'MyString' -length(a) % ans = 8 -a(2) % ans = y -[a,a] % ans = MyStringMyString -b = '字符串' % MATLAB目前已经可以支持包括中文在内的多种文字 -length(b) % ans = 3 -b(2) % ans = 符 -[b,b] % ans = 字符串字符串 - - -% 元组（cell 数组） -a = {'one', 'two', 'three'} -a(1) % ans = 'one' - 返回一个元组 -a{1} % ans = one - 返回一个字符串 - - -% 结构体 -A.b = {'one','two'}; -A.c = [1 2]; -A.d.e = false; - - -% 向量 -x = [4 32 53 7 1] -x(2) % ans = 32，MATLAB中向量的下标索引从1开始，不是0 -x(2:3) % ans = 32 53 -x(2:end) % ans = 32 53 7 1 - -x = [4; 32; 53; 7; 1] % 列向量 - -x = [1:10] % x = 1 2 3 4 5 6 7 8 9 10 - - -% 矩阵 -A = [1 2 3; 4 5 6; 7 8 9] -% 以分号分隔不同的行，以空格或逗号分隔同一行中的不同元素 -% A = - -% 1 2 3 -% 4 5 6 -% 7 8 9 - -A(2,3) % ans = 6，A(row, column) -A(6) % ans = 8 -% （隐式地将 A 的三列首尾相接组成一个列向量，然后取其下标为 6 的元素） - - -A(2,3) = 42 % 将第 2 行第 3 列的元素设为 42 -% A = - -% 1 2 3 -% 4 5 42 -% 7 8 9 - -A(2:3,2:3) % 取原矩阵中的一块作为新矩阵 -%ans = - -% 5 42 -% 8 9 - -A(:,1) % 第 1 列的所有元素 -%ans = - -% 1 -% 4 -% 7 - -A(1,:) % 第 1 行的所有元素 -%ans = - -% 1 2 3 - -[A ; A] % 将两个矩阵上下相接构成新矩阵 -%ans = - -% 1 2 3 -% 4 5 42 -% 7 8 9 -% 1 2 3 -% 4 5 42 -% 7 8 9 - -% 等价于 -vertcat(A, A); - - -[A , A] % 将两个矩阵左右相接构成新矩阵 - -%ans = - -% 1 2 3 1 2 3 -% 4 5 42 4 5 42 -% 7 8 9 7 8 9 - -% 等价于 -horzcat(A, A); - - -A(:, [3 1 2]) % 重新排布原矩阵的各列 -%ans = - -% 3 1 2 -% 42 4 5 -% 9 7 8 - -size(A) % 返回矩阵的行数和列数，ans = 3 3 - -A(1, :) =[] % 删除矩阵的第 1 行 -A(:, 1) =[] % 删除矩阵的第 1 列 - -transpose(A) % 矩阵（非共轭）转置，等价于 A.' （注意！有个点） -ctranspose(A) % 矩阵的共轭转置（对矩阵中的每个元素取共轭复数），等价于 A' - - -% 元素运算 vs. 矩阵运算 -% 单独运算符就是对矩阵整体进行矩阵运算 -% 在运算符加上英文句点就是对矩阵中的元素进行元素计算 -% 示例如下： -A * B % 矩阵乘法，要求 A 的列数等于 B 的行数 -A .* B % 元素乘法，要求 A 和 B 形状一致，即两矩阵行列数完全一致 - % 元素乘法的结果是与 A 和 B 形状一致的矩阵 - % 其每个元素等于 A 对应位置的元素乘 B 对应位置的元素 - -% 以下函数中，函数名以 m 结尾的执行矩阵运算，其余执行元素运算： -exp(A) % 对矩阵中每个元素做指数运算 -expm(A) % 对矩阵整体做指数运算 -sqrt(A) % 对矩阵中每个元素做开方运算 -sqrtm(A) % 对矩阵整体做开方运算（即试图求出一个矩阵，该矩阵与自身的乘积等于 A 矩阵） - - -% 绘图 -x = 0:0.1:2*pi; % 生成一向量，其元素从 0 开始，以 0.1 的间隔一直递增到 2*pi - % 其中 pi 为圆周率 -y = sin(x); -plot(x,y) -xlabel('x axis') -ylabel('y axis') -title('Plot of y = sin(x)') -axis([0 2*pi -1 1]) % x 轴范围是从 0 到 2*pi，y 轴范围是从 -1 到 1 - -plot(x,y1,'-',x,y2,'--',x,y3,':') % 在同一张图中绘制多条曲线 -legend('Line 1 label', 'Line 2 label') % 为图片加注图例 -% 图例数量应当小于或等于实际绘制的曲线数目，从 plot 绘制的第一条曲线开始对应 - -% 在同一张图上绘制多条曲线的另一种方法： -% 使用 hold on，令系统保留前次绘图结果并在其上直接叠加新的曲线， -% 如果没有 hold on，则每个 plot 都会首先清除之前的绘图结果再进行绘制。 -% 在 hold on 和 hold off 中可以放置任意多的 plot 指令， -% 它们和 hold on 前最后一个 plot 指令的结果都将显示在同一张图中。 -plot(x, y1) -hold on -plot(x, y2) -plot(x, y3) -plot(x, y4) -hold off - -loglog(x, y) % 对数—对数绘图 -semilogx(x, y) % 半对数（x 轴对数）绘图 -semilogy(x, y) % 半对数（y 轴对数）绘图 - -fplot (@(x) x^2, [2,5]) % 绘制函数 x^2 在 [2, 5] 区间的曲线 - -grid on % 在绘制的图中显示网格，使用 grid off 可取消网格显示 -axis square % 将当前坐标系设定为正方形（保证在图形显示上各轴等长） -axis equal % 将当前坐标系设定为相等（保证在实际数值上各轴等长） - -scatter(x, y); % 散点图 -hist(x); % 直方图 - -z = sin(x); -plot3(x,y,z); % 绘制三维曲线 - -pcolor(A) % 伪彩色图（热图） -contour(A) % 等高线图 -mesh(A) % 网格曲面图 - -h = figure % 创建新的图片对象并返回其句柄 h -figure(h) % 将句柄 h 对应的图片作为当前图片 -close(h) % 关闭句柄 h 对应的图片 -close all % 关闭 MATLAB 中所用打开的图片 -close % 关闭当前图片 - -shg % 显示图形窗口 -clf clear % 清除图形窗口中的图像，并重置图像属性 - -% 图像属性可以通过图像句柄进行设定 -% 在创建图像时可以保存图像句柄以便于设置 -% 也可以用 gcf 函数返回当前图像的句柄 -h = plot(x, y); % 在创建图像时显式地保存图像句柄 -set(h, 'Color', 'r') -% 颜色代码： -% 'y' 黄色，'m' 洋红，'c' 青色 -% 'r' 红色，'g' 绿色，'b' 蓝色 -% 'w' 白色，'k' 黑色 -set(h, 'Color', [0.5, 0.5, 0.4]) -% 也可以使用 RGB 值指定颜色 -set(h, 'LineStyle', '--') -% 线型代码：'--' 实线，'---' 虚线，':' 点线，'-.' 点划线，'none' 不划线 -get(h, 'LineStyle') -% 获取当前句柄的线型 - - -% 用 gca 函数返回当前图像的坐标轴句柄 -set(gca, 'XDir', 'reverse'); % 令 x 轴反向 - -% 用 subplot 指令创建平铺排列的多张子图 -subplot(2,3,1); % 选择 2 x 3 排列的子图中的第 1 张图 -plot(x1); title('First Plot') % 在选中的图中绘图 -subplot(2,3,2); % 选择 2 x 3 排列的子图中的第 2 张图 -plot(x2); title('Second Plot') % 在选中的图中绘图 - - -% 要调用函数或脚本，必须保证它们在你的当前工作目录中 -path % 显示当前工作目录 -addpath /path/to/dir % 将指定路径加入到当前工作目录中 -rmpath /path/to/dir % 将指定路径从当前工作目录中删除 -cd /path/to/move/into % 以制定路径作为当前工作目录 - - -% 变量可保存到 .mat 格式的本地文件 -save('myFileName.mat') % 保存当前工作空间中的所有变量 -load('myFileName.mat') % 将指定文件中的变量载入到当前工作空间 - - -% .m 脚本文件 -% 脚本文件是一个包含多条 MATLAB 指令的外部文件，以 .m 为后缀名 -% 使用脚本文件可以避免在命令窗口中重复输入冗长的指令 - - -% .m 函数文件 -% 与脚本文件类似，同样以 .m 作为后缀名 -% 但函数文件可以接受用户输入的参数并返回运算结果 -% 并且函数拥有自己的工作空间（变量域），不必担心变量名称冲突 -% 函数文件的名称应当与其所定义的函数的名称一致 -% 比如下面例子中函数文件就应命名为 double_input.m -% 使用 'help double_input.m' 可返回函数定义中第一行注释信息 -function output = double_input(x) - % double_input(x) 返回 x 的 2 倍 - output = 2*x; -end -double_input(6) % ans = 12 - - -% 同样还可以定义子函数和内嵌函数 -% 子函数与主函数放在同一个函数文件中，且只能被这个主函数调用 -% 内嵌函数放在另一个函数体内，可以直接访问被嵌套函数的各个变量 - - -% 使用匿名函数可以不必创建 .m 函数文件 -% 匿名函数适用于快速定义某函数以便传递给另一指令或函数（如绘图、积分、求根、求极值等） -% 下面示例的匿名函数返回输入参数的平方根，可以使用句柄 sqr 进行调用： -sqr = @(x) x.^2; -sqr(10) % ans = 100 -doc function_handle % find out more - - -% 接受用户输入 -a = input('Enter the value: ') - - -% 从文件中读取数据 -fopen(filename) -% 类似函数还有 xlsread（excel 文件）、importdata（CSV 文件）、imread（图像文件） - - -% 输出 -disp(a) % 在命令窗口中打印变量 a 的值 -disp('Hello World') % 在命令窗口中打印字符串 -fprintf % 按照指定格式在命令窗口中打印内容 - -% 条件语句（if 和 elseif 语句中的括号并非必需，但推荐加括号避免混淆） -if (a > 15) - disp('Greater than 15') -elseif (a == 23) - disp('a is 23') -else - disp('neither condition met') -end - -% 循环语句 -% 注意：对向量或矩阵使用循环语句进行元素遍历的效率很低！！ -% 注意：只要有可能，就尽量使用向量或矩阵的整体运算取代逐元素循环遍历！！ -% MATLAB 在开发时对向量和矩阵运算做了专门优化，做向量和矩阵整体运算的效率高于循环语句 -for k = 1:5 - disp(k) -end - -k = 0; -while (k < 5) - k = k + 1; -end - - -% 程序运行计时：'tic' 是计时开始，'toc' 是计时结束并打印结果 -tic -A = rand(1000); -A*A*A*A*A*A*A; -toc - - -% 链接 MySQL 数据库 -dbname = 'database_name'; -username = 'root'; -password = 'root'; -driver = 'com.mysql.jdbc.Driver'; -dburl = ['jdbc:mysql://localhost:8889/' dbname]; -javaclasspath('mysql-connector-java-5.1.xx-bin.jar'); % 此处 xx 代表具体版本号 -% 这里的 mysql-connector-java-5.1.xx-bin.jar 可从 http://dev.mysql.com/downloads/connector/j/ 下载 -conn = database(dbname, username, password, driver, dburl); -sql = ['SELECT * from table_name where id = 22'] % SQL 语句 -a = fetch(conn, sql) % a 即包含所需数据 - - -% 常用数学函数 -sin(x) -cos(x) -tan(x) -asin(x) -acos(x) -atan(x) -exp(x) -sqrt(x) -log(x) -log10(x) -abs(x) -min(x) -max(x) -ceil(x) -floor(x) -round(x) -rem(x) -rand % 均匀分布的伪随机浮点数 -randi % 均匀分布的伪随机整数 -randn % 正态分布的伪随机浮点数 - -% 常用常数 -pi -NaN -inf - -% 求解矩阵方程（如果方程无解，则返回最小二乘近似解） -% \ 操作符等价于 mldivide 函数，/ 操作符等价于 mrdivide 函数 -x=A\b % 求解 Ax=b，比先求逆再左乘 inv(A)*b 更加高效、准确 -x=b/A % 求解 xA=b - -inv(A) % 逆矩阵 -pinv(A) % 伪逆矩阵 - - -% 常用矩阵函数 -zeros(m, n) % m x n 阶矩阵，元素全为 0 -ones(m, n) % m x n 阶矩阵，元素全为 1 -diag(A) % 返回矩阵 A 的对角线元素 -diag(x) % 构造一个对角阵，对角线元素就是向量 x 的各元素 -eye(m, n) % m x n 阶单位矩阵 -linspace(x1, x2, n) % 返回介于 x1 和 x2 之间的 n 个等距节点 -inv(A) % 矩阵 A 的逆矩阵 -det(A) % 矩阵 A 的行列式 -eig(A) % 矩阵 A 的特征值和特征向量 -trace(A) % 矩阵 A 的迹（即对角线元素之和），等价于 sum(diag(A)) -isempty(A) % 测试 A 是否为空 -all(A) % 测试 A 中所有元素是否都非 0 或都为真（逻辑值） -any(A) % 测试 A 中是否有元素非 0 或为真（逻辑值） -isequal(A, B) % 测试 A 和 B是否相等 -numel(A) % 矩阵 A 的元素个数 -triu(x) % 返回 x 的上三角这部分 -tril(x) % 返回 x 的下三角这部分 -cross(A, B) % 返回 A 和 B 的叉积（矢量积、外积） -dot(A, B) % 返回 A 和 B 的点积（数量积、内积），要求 A 和 B 必须等长 -transpose(A) % 矩阵（非共轭）转置，等价于 A.' （注意！有个点） -fliplr(A) % 将一个矩阵左右翻转 -flipud(A) % 将一个矩阵上下翻转 - -% 矩阵分解 -[L, U, P] = lu(A) % LU 分解：PA = LU，L 是下三角阵，U 是上三角阵，P 是置换阵 -[P, D] = eig(A) % 特征值分解：AP = PD - % D 是由特征值构成的对角阵，P 的各列就是对应的特征向量 -[U, S, V] = svd(X) % 奇异值分解：XV = US - % U 和 V 是酉矩阵，S 是由奇异值构成的半正定实数对角阵 - -% 常用向量函数 -max % 最大值 -min % 最小值 -length % 元素个数 -sort % 按升序排列 -sum % 各元素之和 -prod % 各元素之积 -mode % 众数 -median % 中位数 -mean % 平均值 -std % 标准差 -perms(x) % x 元素的全排列 - -``` - -## 相关资料 - -* 官方网页：[MATLAB - 技术计算语言 - MATLAB & Simulink](https://ww2.mathworks.cn/products/matlab.html) -* 官方论坛：[MATLAB Answers - MATLAB Central](https://ww2.mathworks.cn/matlabcentral/answers/) +--- +language: MATLAB +filename: matlab-cn.m +contributors: + - ["mendozao", "http://github.com/mendozao"] + - ["jamesscottbrown", "http://jamesscottbrown.com"] +translators: + - ["sunxb10", "https://github.com/sunxb10"] +lang: zh-cn + +--- + +MATLAB 是 MATrix LABoratory（矩阵实验室）的缩写。 +它是一种功能强大的数值计算语言，在工程和数学领域中应用广泛。 + +如果您有任何需要反馈或交流的内容，请联系本教程作者： +[@the_ozzinator](https://twitter.com/the_ozzinator) +或 [osvaldo.t.mendoza@gmail.com](mailto:osvaldo.t.mendoza@gmail.com)。 + +```matlab +% 以百分号作为注释符 + +%{ +多行注释 +可以 +这样 +表示 +%} + +% 指令可以随意跨行，但需要在跨行处用 '...' 标明： + a = 1 + 2 + ... + + 4 + +% 可以在MATLAB中直接向操作系统发出指令 +!ping google.com + +who % 显示内存中的所有变量 +whos % 显示内存中的所有变量以及它们的类型 +clear % 清除内存中的所有变量 +clear('A') % 清除指定的变量 +openvar('A') % 在变量编辑器中编辑指定变量 + +clc % 清除命令窗口中显示的所有指令 +diary % 将命令窗口中的内容写入本地文件 +ctrl-c % 终止当前计算 + +edit('myfunction.m') % 在编辑器中打开指定函数或脚本 +type('myfunction.m') % 在命令窗口中打印指定函数或脚本的源码 + +profile on % 打开 profile 代码分析工具 +profile off % 关闭 profile 代码分析工具 +profile viewer % 查看 profile 代码分析工具的分析结果 + +help command % 在命令窗口中显示指定命令的帮助文档 +doc command % 在帮助窗口中显示指定命令的帮助文档 +lookfor command % 在所有 MATLAB 内置函数的头部注释块的第一行中搜索指定命令 +lookfor command -all % 在所有 MATLAB 内置函数的整个头部注释块中搜索指定命令 + + +% 输出格式 +format short % 浮点数保留 4 位小数 +format long % 浮点数保留 15 位小数 +format bank % 金融格式，浮点数只保留 2 位小数 +fprintf('text') % 在命令窗口中显示 "text" +disp('text') % 在命令窗口中显示 "text" + + +% 变量与表达式 +myVariable = 4 % 命令窗口中将新创建的变量 +myVariable = 4; % 加上分号可使命令窗口中不显示当前语句执行结果 +4 + 6 % ans = 10 +8 * myVariable % ans = 32 +2 ^ 3 % ans = 8 +a = 2; b = 3; +c = exp(a)*sin(pi/2) % c = 7.3891 + + +% 调用函数有两种方式： +% 标准函数语法： +load('myFile.mat', 'y') % 参数放在括号内，以英文逗号分隔 +% 指令语法: +load myFile.mat y % 不加括号，以空格分隔参数 +% 注意在指令语法中参数不需要加引号：在这种语法下，所有输入参数都只能是文本文字， +% 不能是变量的具体值，同样也不能是输出变量 +[V,D] = eig(A); % 这条函数调用无法转换成等价的指令语法 +[~,D] = eig(A); % 如果结果中只需要 D 而不需要 V 则可以这样写 + + + +% 逻辑运算 +1 > 5 % 假，ans = 0 +10 >= 10 % 真，ans = 1 +3 ~= 4 % 不等于 -> ans = 1 +3 == 3 % 等于 -> ans = 1 +3 > 1 && 4 > 1 % 与 -> ans = 1 +3 > 1 || 4 > 1 % 或 -> ans = 1 +~1 % 非 -> ans = 0 + +% 逻辑运算可直接应用于矩阵，运算结果也是矩阵 +A > 5 +% 对矩阵中每个元素做逻辑运算，若为真，则在运算结果的矩阵中对应位置的元素就是 1 +A( A > 5 ) +% 如此返回的向量，其元素就是 A 矩阵中所有逻辑运算为真的元素 + +% 字符串 +a = 'MyString' +length(a) % ans = 8 +a(2) % ans = y +[a,a] % ans = MyStringMyString +b = '字符串' % MATLAB目前已经可以支持包括中文在内的多种文字 +length(b) % ans = 3 +b(2) % ans = 符 +[b,b] % ans = 字符串字符串 + + +% 元组（cell 数组） +a = {'one', 'two', 'three'} +a(1) % ans = 'one' - 返回一个元组 +a{1} % ans = one - 返回一个字符串 + + +% 结构体 +A.b = {'one','two'}; +A.c = [1 2]; +A.d.e = false; + + +% 向量 +x = [4 32 53 7 1] +x(2) % ans = 32，MATLAB中向量的下标索引从1开始，不是0 +x(2:3) % ans = 32 53 +x(2:end) % ans = 32 53 7 1 + +x = [4; 32; 53; 7; 1] % 列向量 + +x = [1:10] % x = 1 2 3 4 5 6 7 8 9 10 + + +% 矩阵 +A = [1 2 3; 4 5 6; 7 8 9] +% 以分号分隔不同的行，以空格或逗号分隔同一行中的不同元素 +% A = + +% 1 2 3 +% 4 5 6 +% 7 8 9 + +A(2,3) % ans = 6，A(row, column) +A(6) % ans = 8 +% （隐式地将 A 的三列首尾相接组成一个列向量，然后取其下标为 6 的元素） + + +A(2,3) = 42 % 将第 2 行第 3 列的元素设为 42 +% A = + +% 1 2 3 +% 4 5 42 +% 7 8 9 + +A(2:3,2:3) % 取原矩阵中的一块作为新矩阵 +%ans = + +% 5 42 +% 8 9 + +A(:,1) % 第 1 列的所有元素 +%ans = + +% 1 +% 4 +% 7 + +A(1,:) % 第 1 行的所有元素 +%ans = + +% 1 2 3 + +[A ; A] % 将两个矩阵上下相接构成新矩阵 +%ans = + +% 1 2 3 +% 4 5 42 +% 7 8 9 +% 1 2 3 +% 4 5 42 +% 7 8 9 + +% 等价于 +vertcat(A, A); + + +[A , A] % 将两个矩阵左右相接构成新矩阵 + +%ans = + +% 1 2 3 1 2 3 +% 4 5 42 4 5 42 +% 7 8 9 7 8 9 + +% 等价于 +horzcat(A, A); + + +A(:, [3 1 2]) % 重新排布原矩阵的各列 +%ans = + +% 3 1 2 +% 42 4 5 +% 9 7 8 + +size(A) % 返回矩阵的行数和列数，ans = 3 3 + +A(1, :) =[] % 删除矩阵的第 1 行 +A(:, 1) =[] % 删除矩阵的第 1 列 + +transpose(A) % 矩阵（非共轭）转置，等价于 A.' （注意！有个点） +ctranspose(A) % 矩阵的共轭转置（对矩阵中的每个元素取共轭复数），等价于 A' + + +% 元素运算 vs. 矩阵运算 +% 单独运算符就是对矩阵整体进行矩阵运算 +% 在运算符加上英文句点就是对矩阵中的元素进行元素计算 +% 示例如下： +A * B % 矩阵乘法，要求 A 的列数等于 B 的行数 +A .* B % 元素乘法，要求 A 和 B 形状一致，即两矩阵行列数完全一致 + % 元素乘法的结果是与 A 和 B 形状一致的矩阵 + % 其每个元素等于 A 对应位置的元素乘 B 对应位置的元素 + +% 以下函数中，函数名以 m 结尾的执行矩阵运算，其余执行元素运算： +exp(A) % 对矩阵中每个元素做指数运算 +expm(A) % 对矩阵整体做指数运算 +sqrt(A) % 对矩阵中每个元素做开方运算 +sqrtm(A) % 对矩阵整体做开方运算（即试图求出一个矩阵，该矩阵与自身的乘积等于 A 矩阵） + + +% 绘图 +x = 0:0.1:2*pi; % 生成一向量，其元素从 0 开始，以 0.1 的间隔一直递增到 2*pi + % 其中 pi 为圆周率 +y = sin(x); +plot(x,y) +xlabel('x axis') +ylabel('y axis') +title('Plot of y = sin(x)') +axis([0 2*pi -1 1]) % x 轴范围是从 0 到 2*pi，y 轴范围是从 -1 到 1 + +plot(x,y1,'-',x,y2,'--',x,y3,':') % 在同一张图中绘制多条曲线 +legend('Line 1 label', 'Line 2 label') % 为图片加注图例 +% 图例数量应当小于或等于实际绘制的曲线数目，从 plot 绘制的第一条曲线开始对应 + +% 在同一张图上绘制多条曲线的另一种方法： +% 使用 hold on，令系统保留前次绘图结果并在其上直接叠加新的曲线， +% 如果没有 hold on，则每个 plot 都会首先清除之前的绘图结果再进行绘制。 +% 在 hold on 和 hold off 中可以放置任意多的 plot 指令， +% 它们和 hold on 前最后一个 plot 指令的结果都将显示在同一张图中。 +plot(x, y1) +hold on +plot(x, y2) +plot(x, y3) +plot(x, y4) +hold off + +loglog(x, y) % 对数—对数绘图 +semilogx(x, y) % 半对数（x 轴对数）绘图 +semilogy(x, y) % 半对数（y 轴对数）绘图 + +fplot (@(x) x^2, [2,5]) % 绘制函数 x^2 在 [2, 5] 区间的曲线 + +grid on % 在绘制的图中显示网格，使用 grid off 可取消网格显示 +axis square % 将当前坐标系设定为正方形（保证在图形显示上各轴等长） +axis equal % 将当前坐标系设定为相等（保证在实际数值上各轴等长） + +scatter(x, y); % 散点图 +hist(x); % 直方图 + +z = sin(x); +plot3(x,y,z); % 绘制三维曲线 + +pcolor(A) % 伪彩色图（热图） +contour(A) % 等高线图 +mesh(A) % 网格曲面图 + +h = figure % 创建新的图片对象并返回其句柄 h +figure(h) % 将句柄 h 对应的图片作为当前图片 +close(h) % 关闭句柄 h 对应的图片 +close all % 关闭 MATLAB 中所用打开的图片 +close % 关闭当前图片 + +shg % 显示图形窗口 +clf clear % 清除图形窗口中的图像，并重置图像属性 + +% 图像属性可以通过图像句柄进行设定 +% 在创建图像时可以保存图像句柄以便于设置 +% 也可以用 gcf 函数返回当前图像的句柄 +h = plot(x, y); % 在创建图像时显式地保存图像句柄 +set(h, 'Color', 'r') +% 颜色代码： +% 'y' 黄色，'m' 洋红，'c' 青色 +% 'r' 红色，'g' 绿色，'b' 蓝色 +% 'w' 白色，'k' 黑色 +set(h, 'Color', [0.5, 0.5, 0.4]) +% 也可以使用 RGB 值指定颜色 +set(h, 'LineStyle', '--') +% 线型代码：'--' 实线，'---' 虚线，':' 点线，'-.' 点划线，'none' 不划线 +get(h, 'LineStyle') +% 获取当前句柄的线型 + + +% 用 gca 函数返回当前图像的坐标轴句柄 +set(gca, 'XDir', 'reverse'); % 令 x 轴反向 + +% 用 subplot 指令创建平铺排列的多张子图 +subplot(2,3,1); % 选择 2 x 3 排列的子图中的第 1 张图 +plot(x1); title('First Plot') % 在选中的图中绘图 +subplot(2,3,2); % 选择 2 x 3 排列的子图中的第 2 张图 +plot(x2); title('Second Plot') % 在选中的图中绘图 + + +% 要调用函数或脚本，必须保证它们在你的当前工作目录中 +path % 显示当前工作目录 +addpath /path/to/dir % 将指定路径加入到当前工作目录中 +rmpath /path/to/dir % 将指定路径从当前工作目录中删除 +cd /path/to/move/into % 以制定路径作为当前工作目录 + + +% 变量可保存到 .mat 格式的本地文件 +save('myFileName.mat') % 保存当前工作空间中的所有变量 +load('myFileName.mat') % 将指定文件中的变量载入到当前工作空间 + + +% .m 脚本文件 +% 脚本文件是一个包含多条 MATLAB 指令的外部文件，以 .m 为后缀名 +% 使用脚本文件可以避免在命令窗口中重复输入冗长的指令 + + +% .m 函数文件 +% 与脚本文件类似，同样以 .m 作为后缀名 +% 但函数文件可以接受用户输入的参数并返回运算结果 +% 并且函数拥有自己的工作空间（变量域），不必担心变量名称冲突 +% 函数文件的名称应当与其所定义的函数的名称一致 +% 比如下面例子中函数文件就应命名为 double_input.m +% 使用 'help double_input.m' 可返回函数定义中第一行注释信息 +function output = double_input(x) + % double_input(x) 返回 x 的 2 倍 + output = 2*x; +end +double_input(6) % ans = 12 + + +% 同样还可以定义子函数和内嵌函数 +% 子函数与主函数放在同一个函数文件中，且只能被这个主函数调用 +% 内嵌函数放在另一个函数体内，可以直接访问被嵌套函数的各个变量 + + +% 使用匿名函数可以不必创建 .m 函数文件 +% 匿名函数适用于快速定义某函数以便传递给另一指令或函数（如绘图、积分、求根、求极值等） +% 下面示例的匿名函数返回输入参数的平方根，可以使用句柄 sqr 进行调用： +sqr = @(x) x.^2; +sqr(10) % ans = 100 +doc function_handle % find out more + + +% 接受用户输入 +a = input('Enter the value: ') + + +% 从文件中读取数据 +fopen(filename) +% 类似函数还有 xlsread（excel 文件）、importdata（CSV 文件）、imread（图像文件） + + +% 输出 +disp(a) % 在命令窗口中打印变量 a 的值 +disp('Hello World') % 在命令窗口中打印字符串 +fprintf % 按照指定格式在命令窗口中打印内容 + +% 条件语句（if 和 elseif 语句中的括号并非必需，但推荐加括号避免混淆） +if (a > 15) + disp('Greater than 15') +elseif (a == 23) + disp('a is 23') +else + disp('neither condition met') +end + +% 循环语句 +% 注意：对向量或矩阵使用循环语句进行元素遍历的效率很低！！ +% 注意：只要有可能，就尽量使用向量或矩阵的整体运算取代逐元素循环遍历！！ +% MATLAB 在开发时对向量和矩阵运算做了专门优化，做向量和矩阵整体运算的效率高于循环语句 +for k = 1:5 + disp(k) +end + +k = 0; +while (k < 5) + k = k + 1; +end + + +% 程序运行计时：'tic' 是计时开始，'toc' 是计时结束并打印结果 +tic +A = rand(1000); +A*A*A*A*A*A*A; +toc + + +% 链接 MySQL 数据库 +dbname = 'database_name'; +username = 'root'; +password = 'root'; +driver = 'com.mysql.jdbc.Driver'; +dburl = ['jdbc:mysql://localhost:8889/' dbname]; +javaclasspath('mysql-connector-java-5.1.xx-bin.jar'); % 此处 xx 代表具体版本号 +% 这里的 mysql-connector-java-5.1.xx-bin.jar 可从 http://dev.mysql.com/downloads/connector/j/ 下载 +conn = database(dbname, username, password, driver, dburl); +sql = ['SELECT * from table_name where id = 22'] % SQL 语句 +a = fetch(conn, sql) % a 即包含所需数据 + + +% 常用数学函数 +sin(x) +cos(x) +tan(x) +asin(x) +acos(x) +atan(x) +exp(x) +sqrt(x) +log(x) +log10(x) +abs(x) +min(x) +max(x) +ceil(x) +floor(x) +round(x) +rem(x) +rand % 均匀分布的伪随机浮点数 +randi % 均匀分布的伪随机整数 +randn % 正态分布的伪随机浮点数 + +% 常用常数 +pi +NaN +inf + +% 求解矩阵方程（如果方程无解，则返回最小二乘近似解） +% \ 操作符等价于 mldivide 函数，/ 操作符等价于 mrdivide 函数 +x=A\b % 求解 Ax=b，比先求逆再左乘 inv(A)*b 更加高效、准确 +x=b/A % 求解 xA=b + +inv(A) % 逆矩阵 +pinv(A) % 伪逆矩阵 + + +% 常用矩阵函数 +zeros(m, n) % m x n 阶矩阵，元素全为 0 +ones(m, n) % m x n 阶矩阵，元素全为 1 +diag(A) % 返回矩阵 A 的对角线元素 +diag(x) % 构造一个对角阵，对角线元素就是向量 x 的各元素 +eye(m, n) % m x n 阶单位矩阵 +linspace(x1, x2, n) % 返回介于 x1 和 x2 之间的 n 个等距节点 +inv(A) % 矩阵 A 的逆矩阵 +det(A) % 矩阵 A 的行列式 +eig(A) % 矩阵 A 的特征值和特征向量 +trace(A) % 矩阵 A 的迹（即对角线元素之和），等价于 sum(diag(A)) +isempty(A) % 测试 A 是否为空 +all(A) % 测试 A 中所有元素是否都非 0 或都为真（逻辑值） +any(A) % 测试 A 中是否有元素非 0 或为真（逻辑值） +isequal(A, B) % 测试 A 和 B是否相等 +numel(A) % 矩阵 A 的元素个数 +triu(x) % 返回 x 的上三角这部分 +tril(x) % 返回 x 的下三角这部分 +cross(A, B) % 返回 A 和 B 的叉积（矢量积、外积） +dot(A, B) % 返回 A 和 B 的点积（数量积、内积），要求 A 和 B 必须等长 +transpose(A) % 矩阵（非共轭）转置，等价于 A.' （注意！有个点） +fliplr(A) % 将一个矩阵左右翻转 +flipud(A) % 将一个矩阵上下翻转 + +% 矩阵分解 +[L, U, P] = lu(A) % LU 分解：PA = LU，L 是下三角阵，U 是上三角阵，P 是置换阵 +[P, D] = eig(A) % 特征值分解：AP = PD + % D 是由特征值构成的对角阵，P 的各列就是对应的特征向量 +[U, S, V] = svd(X) % 奇异值分解：XV = US + % U 和 V 是酉矩阵，S 是由奇异值构成的半正定实数对角阵 + +% 常用向量函数 +max % 最大值 +min % 最小值 +length % 元素个数 +sort % 按升序排列 +sum % 各元素之和 +prod % 各元素之积 +mode % 众数 +median % 中位数 +mean % 平均值 +std % 标准差 +perms(x) % x 元素的全排列 + +``` + +## 相关资料 + +* 官方网页：[MATLAB - 技术计算语言 - MATLAB & Simulink](https://ww2.mathworks.cn/products/matlab.html) +* 官方论坛：[MATLAB Answers - MATLAB Central](https://ww2.mathworks.cn/matlabcentral/answers/)