blob: 8a9e37e81230c9544628fd5b0182cfdb90439f72 [file] [log] [blame]
Bram Moolenaar71badf92023-04-22 22:40:14 +01001*vim9class.txt* For Vim version 9.0. Last change: 2023 Mar 22
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00007NOTE - This is not finished yet, anything can still change! - NOTE
Bram Moolenaarc1c365c2022-12-04 20:13:24 +00008
9
10Vim9 classes, objects, interfaces, types and enums.
11
121. Overview |Vim9-class-overview|
132. A simple class |Vim9-simple-class|
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000143. Class members and functions |Vim9-class-member|
154. Using an abstract class |Vim9-abstract-class|
165. Using an interface |Vim9-using-interface|
176. More class details |Vim9-class|
187. Type definition |Vim9-type|
198. Enum |Vim9-enum|
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000020
219. Rationale
2210. To be done later
23
24==============================================================================
25
261. Overview *Vim9-class-overview*
27
28The fancy term is "object-oriented programming". You can find lots of study
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000029material on this subject. Here we document what |Vim9| script provides,
30assuming you know the basics already. Added are helpful hints about how to
31use this functionality effectively.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000032
33The basic item is an object:
34- An object stores state. It contains one or more variables that can each
35 have a value.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000036- An object provides functions that use and manipulate its state. These
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000037 functions are invoked "on the object", which is what sets it apart from the
38 traditional separation of data and code that manipulates the data.
39- An object has a well defined interface, with typed member variables and
40 member functions.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000041- Objects are created from a class and all objects have the same interface.
42 This does not change at runtime, it is not dynamic.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000043
44An object can only be created by a class. A class provides:
45- A new() method, the constructor, which returns an object for the class.
46 This method is invoked on the class name: MyClass.new().
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000047- State shared by all objects of the class: class variables (class members).
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000048- A hierarchy of classes, with super-classes and sub-classes, inheritance.
49
50An interface is used to specify properties of an object:
51- An object can declare several interfaces that it implements.
52- Different objects implementing the same interface can be used the same way.
53
54The class hierarchy allows for single inheritance. Otherwise interfaces are
55to be used where needed.
56
57
58Class modeling ~
59
60You can model classes any way you like. Keep in mind what you are building,
61don't try to model the real world. This can be confusing, especially because
62teachers use real-world objects to explain class relations and you might think
63your model should therefore reflect the real world. It doesn't! The model
64should match your purpose.
65
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000066Keep in mind that composition (an object contains other objects) is often
67better than inheritance (an object extends another object). Don't waste time
68trying to find the optimal class model. Or waste time discussing whether a
69square is a rectangle or that a rectangle is a square. It doesn't matter.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000070
71
72==============================================================================
73
742. A simple class *Vim9-simple-class*
75
Bram Moolenaarbe4e0162023-02-02 13:59:48 +000076Let's start with a simple example: a class that stores a text position (see
77below for how to do this more efficiently): >
Bram Moolenaarc1c365c2022-12-04 20:13:24 +000078
79 class TextPosition
80 this.lnum: number
81 this.col: number
82
83 def new(lnum: number, col: number)
84 this.lnum = lnum
85 this.col = col
86 enddef
87
88 def SetLnum(lnum: number)
89 this.lnum = lnum
90 enddef
91
92 def SetCol(col: number)
93 this.col = col
94 enddef
95
96 def SetPosition(lnum: number, col: number)
97 this.lnum = lnum
98 this.col = col
99 enddef
100 endclass
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000101< *object* *Object*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000102You can create an object from this class with the new() method: >
103
104 var pos = TextPosition.new(1, 1)
105
106The object members "lnum" and "col" can be accessed directly: >
107
108 echo $'The text position is ({pos.lnum}, {pos.col})'
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000109< *E1317* *E1327*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000110If you have been using other object-oriented languages you will notice that
111in Vim the object members are consistently referred to with the "this."
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000112prefix. This is different from languages like Java and TypeScript. The
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000113naming convention makes the object members easy to spot. Also, when a
114variable does not have the "this." prefix you know it is not an object member.
115
116
117Member write access ~
118
119Now try to change an object member directly: >
120
121 pos.lnum = 9
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000122< *E1335*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000123This will give you an error! That is because by default object members can be
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000124read but not set. That's why the TextPosition class provides a method for it: >
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000125
126 pos.SetLnum(9)
127
128Allowing to read but not set an object member is the most common and safest
129way. Most often there is no problem using a value, while setting a value may
130have side effects that need to be taken care of. In this case, the SetLnum()
131method could check if the line number is valid and either give an error or use
132the closest valid value.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000133 *:public* *E1331*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000134If you don't care about side effects and want to allow the object member to be
135changed at any time, you can make it public: >
136
137 public this.lnum: number
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000138 public this.col: number
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000139
140Now you don't need the SetLnum(), SetCol() and SetPosition() methods, setting
141"pos.lnum" directly above will no longer give an error.
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000142 *E1334*
143If you try to set an object member that doesn't exist you get an error: >
144 pos.other = 9
145< E1334: Object member not found: other ~
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000146
147
148Private members ~
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000149 *E1332* *E1333*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000150On the other hand, if you do not want the object members to be read directly,
151you can make them private. This is done by prefixing an underscore to the
152name: >
153
154 this._lnum: number
155 this._col number
156
157Now you need to provide methods to get the value of the private members.
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000158These are commonly called getters. We recommend using a name that starts with
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000159"Get": >
160
161 def GetLnum(): number
162 return this._lnum
163 enddef
164
165 def GetCol() number
166 return this._col
167 enddef
168
169This example isn't very useful, the members might as well have been public.
170It does become useful if you check the value. For example, restrict the line
171number to the total number of lines: >
172
173 def GetLnum(): number
174 if this._lnum > this._lineCount
175 return this._lineCount
176 endif
177 return this._lnum
178 enddef
179
180
Yegappan Lakshmanancd7293b2023-08-27 19:18:23 +0200181Private methods ~
182If you want object methods to be accessible only from other methods of the
183same class and not used from outside the class, then you can make them
184private. This is done by prefixing the method name with an underscore: >
185
186 class SomeClass
187 def _Foo(): number
188 return 10
189 enddef
190 def Bar(): number
191 return this._Foo()
192 enddef
193 endclass
194<
195Accessing a private method outside the class will result in an error (using
196the above class): >
197
198 var a = SomeClass.new()
199 a._Foo()
200<
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000201Simplifying the new() method ~
202
203Many constructors take values for the object members. Thus you very often see
204this pattern: >
205
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000206 class SomeClass
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000207 this.lnum: number
208 this.col: number
209
210 def new(lnum: number, col: number)
211 this.lnum = lnum
212 this.col = col
213 enddef
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000214 endclass
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000215
216Not only is this text you need to write, it also has the type of each member
217twice. Since this is so common a shorter way to write new() is provided: >
218
219 def new(this.lnum, this.col)
220 enddef
221
222The semantics are easy to understand: Providing the object member name,
223including "this.", as the argument to new() means the value provided in the
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000224new() call is assigned to that object member. This mechanism comes from the
225Dart language.
226
227Putting together this way of using new() and making the members public results
Bram Moolenaar71badf92023-04-22 22:40:14 +0100228in a much shorter class definition than what we started with: >
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000229
230 class TextPosition
231 public this.lnum: number
232 public this.col: number
233
234 def new(this.lnum, this.col)
235 enddef
236
237 def SetPosition(lnum: number, col: number)
238 this.lnum = lnum
239 this.col = col
240 enddef
241 endclass
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000242
243The sequence of constructing a new object is:
2441. Memory is allocated and cleared. All values are zero/false/empty.
2452. For each declared member that has an initializer, the expression is
246 evaluated and assigned to the member. This happens in the sequence the
247 members are declared in the class.
2483. Arguments in the new() method in the "this.name" form are assigned.
2494. The body of the new() method is executed.
250
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000251If the class extends a parent class, the same thing happens. In the second
252step the members of the parent class are done first. There is no need to call
253"super()" or "new()" on the parent.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000254
Yegappan Lakshmanan6ac15442023-08-20 18:20:17 +0200255When defining the new() method the return type should not be specified. It
256always returns an object of the class.
257
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000258==============================================================================
259
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00002603. class members and functions *Vim9-class-member*
261
262 *:static* *E1337* *E1338*
263Class members are declared with "static". They are used by the name without a
264prefix: >
265
266 class OtherThing
267 this.size: number
268 static totalSize: number
269
270 def new(this.size)
271 totalSize += this.size
272 enddef
273 endclass
274< *E1340* *E1341*
275Since the name is used as-is, shadowing the name by a function argument name
276or local variable name is not allowed.
277
278Just like object members the access can be made private by using an underscore
279as the first character in the name, and it can be made public by prefixing
280"public": >
281
282 class OtherThing
283 static total: number # anybody can read, only class can write
284 static _sum: number # only class can read and write
285 public static result: number # anybody can read and write
286 endclass
287<
288 *class-function*
289Class functions are also declared with "static". They have no access to
290object members, they cannot use the "this" keyword. >
291
292 class OtherThing
293 this.size: number
294 static totalSize: number
295
296 # Clear the total size and return the value it had before.
297 static def ClearTotalSize(): number
298 var prev = totalSize
299 totalSize = 0
300 return prev
301 enddef
302 endclass
303
304Inside the class the function can be called by name directly, outside the
305class the class name must be prefixed: `OtherThing.ClearTotalSize()`.
306
Yegappan Lakshmanancd7293b2023-08-27 19:18:23 +0200307Just like object methods the access can be made private by using an underscore
308as the first character in the method name: >
309
310 class OtherThing
311 static def _Foo()
312 echo "Foo"
313 enddef
314 def Bar()
315 OtherThing._Foo()
316 enddef
317 endclass
Gianmaria Bajo4b9777a2023-08-29 22:26:30 +0200318<
319 *E1370*
320Note that constructors cannot be declared as "static", because they always
321are.
Yegappan Lakshmanancd7293b2023-08-27 19:18:23 +0200322
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000323==============================================================================
324
3254. Using an abstract class *Vim9-abstract-class*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000326
327An abstract class forms the base for at least one sub-class. In the class
328model one often finds that a few classes have the same properties that can be
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000329shared, but a class with these properties does not have enough state to create
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000330an object from. A sub-class must extend the abstract class and add the
331missing state and/or methods before it can be used to create objects for.
332
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000333For example, a Shape class could store a color and thickness. You cannot
334create a Shape object, it is missing the information about what kind of shape
335it is. The Shape class functions as the base for a Square and a Triangle
336class, for which objects can be created. Example: >
337
338 abstract class Shape
339 this.color = Color.Black
340 this.thickness = 10
341 endclass
342
343 class Square extends Shape
344 this.size: number
345
346 def new(this.size)
347 enddef
348 endclass
349
350 class Triangle extends Shape
351 this.base: number
352 this.height: number
353
354 def new(this.base, this.height)
355 enddef
356 endclass
357<
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000358An abstract class is defined the same way as a normal class, except that it
359does not have any new() method. *E1359*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000360
361
362==============================================================================
363
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00003645. Using an interface *Vim9-using-interface*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000365
366The example above with Shape, Square and Triangle can be made more useful if
367we add a method to compute the surface of the object. For that we create the
368interface called HasSurface, which specifies one method Surface() that returns
369a number. This example extends the one above: >
370
371 abstract class Shape
372 this.color = Color.Black
373 this.thickness = 10
374 endclass
375
376 interface HasSurface
377 def Surface(): number
378 endinterface
379
380 class Square extends Shape implements HasSurface
381 this.size: number
382
383 def new(this.size)
384 enddef
385
386 def Surface(): number
387 return this.size * this.size
388 enddef
389 endclass
390
391 class Triangle extends Shape implements HasSurface
392 this.base: number
393 this.height: number
394
395 def new(this.base, this.height)
396 enddef
397
398 def Surface(): number
399 return this.base * this.height / 2
400 enddef
401 endclass
402
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000403If a class declares to implement an interface, all the items specified in the
404interface must appear in the class, with the same types. *E1348* *E1349*
405
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000406The interface name can be used as a type: >
407
408 var shapes: list<HasSurface> = [
409 Square.new(12),
410 Triangle.new(8, 15),
411 ]
412 for shape in shapes
413 echo $'the surface is {shape.Surface()}'
414 endfor
415
416
417==============================================================================
418
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00004196. More class details *Vim9-class* *Class* *class*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000420
421Defining a class ~
422 *:class* *:endclass* *:abstract*
423A class is defined between `:class` and `:endclass`. The whole class is
424defined in one script file. It is not possible to add to a class later.
425
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000426A class can only be defined in a |Vim9| script file. *E1316*
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000427A class cannot be defined inside a function.
428
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000429It is possible to define more than one class in a script file. Although it
430usually is better to export only one main class. It can be useful to define
431types, enums and helper classes though.
432
433The `:abstract` keyword may be prefixed and `:export` may be used. That gives
434these variants: >
435
436 class ClassName
437 endclass
438
439 export class ClassName
440 endclass
441
442 abstract class ClassName
443 endclass
444
445 export abstract class ClassName
446 endclass
447<
448 *E1314*
449The class name should be CamelCased. It must start with an uppercase letter.
450That avoids clashing with builtin types.
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000451 *E1315*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000452After the class name these optional items can be used. Each can appear only
453once. They can appear in any order, although this order is recommended: >
454 extends ClassName
455 implements InterfaceName, OtherInterface
456 specifies SomeInterface
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000457< *E1355*
458Each member and function name can be used only once. It is not possible to
459define a function with the same name and different type of arguments.
460
461
Yegappan Lakshmanan618e47d2023-08-22 21:29:28 +0200462Member Initialization ~
463If the type of a member is not explicitly specified in a class, then it is set
464to "any" during class definition. When an object is instantiated from the
465class, then the type of the member is set.
466
467
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000468Extending a class ~
469 *extends*
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000470A class can extend one other class. *E1352* *E1353* *E1354*
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000471The basic idea is to build on top of an existing class, add properties to it.
472
473The extended class is called the "base class" or "super class". The new class
474is called the "child class".
475
476Object members from the base class are all taken over by the child class. It
477is not possible to override them (unlike some other languages).
478
479 *E1356* *E1357* *E1358*
480Object methods of the base class can be overruled. The signature (arguments,
481argument types and return type) must be exactly the same. The method of the
482base class can be called by prefixing "super.".
483
484Other object methods of the base class are taken over by the child class.
485
486Class functions, including functions starting with "new", can be overruled,
487like with object methods. The function on the base class can be called by
488prefixing the name of the class (for class functions) or "super.".
489
490Unlike other languages, the constructor of the base class does not need to be
491invoked. In fact, it cannot be invoked. If some initialization from the base
492class also needs to be done in a child class, put it in an object method and
493call that method from every constructor().
494
495If the base class did not specify a new() function then one was automatically
496created. This function will not be taken over by the child class. The child
497class can define its own new() function, or, if there isn't one, a new()
498function will be added automatically.
499
500
501A class implementing an interface ~
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000502 *implements* *E1346* *E1347*
503A class can implement one or more interfaces. The "implements" keyword can
504only appear once *E1350* . Multiple interfaces can be specified, separated by
505commas. Each interface name can appear only once. *E1351*
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000506
507
508A class defining an interface ~
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000509 *specifies*
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000510A class can declare its interface, the object members and methods, with a
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000511named interface. This avoids the need for separately specifying the
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000512interface, which is often done in many languages, especially Java.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000513
514
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000515Items in a class ~
516 *E1318* *E1325* *E1326*
Bram Moolenaardd60c362023-02-27 15:49:53 +0000517Inside a class, in between `:class` and `:endclass`, these items can appear:
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000518- An object member declaration: >
Bram Moolenaar938ae282023-02-20 20:44:55 +0000519 this._memberName: memberType
520 this.memberName: memberType
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000521 public this.memberName: memberType
522- A constructor method: >
Bram Moolenaar938ae282023-02-20 20:44:55 +0000523 def new(arguments)
524 def newName(arguments)
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000525- An object method: >
Bram Moolenaar938ae282023-02-20 20:44:55 +0000526 def SomeMethod(arguments)
Bram Moolenaarf1dcd142022-12-31 15:30:45 +0000527< *E1329*
528For the object member the type must be specified. The best way is to do this
529explicitly with ": {type}". For simple types you can also use an initializer,
530such as "= 123", and Vim will see that the type is a number. Avoid doing this
531for more complex types and when the type will be incomplete. For example: >
532 this.nameList = []
533This specifies a list, but the item type is unknown. Better use: >
534 this.nameList: list<string>
535The initialization isn't needed, the list is empty by default.
536 *E1330*
537Some types cannot be used, such as "void", "null" and "v:none".
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000538
539
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000540Defining an interface ~
541 *:interface* *:endinterface*
542An interface is defined between `:interface` and `:endinterface`. It may be
543prefixed with `:export`: >
544
545 interface InterfaceName
546 endinterface
547
548 export interface InterfaceName
549 endinterface
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000550< *E1344*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000551An interface can declare object members, just like in a class but without any
552initializer.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000553 *E1345*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000554An interface can declare methods with `:def`, including the arguments and
555return type, but without the body and without `:enddef`. Example: >
556
557 interface HasSurface
558 this.size: number
559 def Surface(): number
560 endinterface
561
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000562An interface name must start with an uppercase letter. *E1343*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000563The "Has" prefix can be used to make it easier to guess this is an interface
564name, with a hint about what it provides.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000565An interface can only be defined in a |Vim9| script file. *E1342*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000566
567
Bram Moolenaar938ae282023-02-20 20:44:55 +0000568null object ~
569
Bram Moolenaardd60c362023-02-27 15:49:53 +0000570When a variable is declared to have the type of an object, but it is not
Bram Moolenaar938ae282023-02-20 20:44:55 +0000571initialized, the value is null. When trying to use this null object Vim often
572does not know what class was supposed to be used. Vim then cannot check if
573a member name is correct and you will get an "Using a null object" error,
Bram Moolenaar71badf92023-04-22 22:40:14 +0100574even when the member name is invalid. *E1360* *E1362* *E1363*
Bram Moolenaar938ae282023-02-20 20:44:55 +0000575
576
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000577Default constructor ~
578
579In case you define a class without a new() method, one will be automatically
580defined. This default constructor will have arguments for all the object
581members, in the order they were specified. Thus if your class looks like: >
582
583 class AutoNew
584 this.name: string
585 this.age: number
586 this.gender: Gender
587 endclass
588
589Then The default constructor will be: >
590
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000591 def new(this.name = v:none, this.age = v:none, this.gender = v:none)
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000592 enddef
593
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000594The "= v:none" default values make the arguments optional. Thus you can also
595call `new()` without any arguments. No assignment will happen and the default
596value for the object members will be used. This is a more useful example,
597with default values: >
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000598
599 class TextPosition
600 this.lnum: number = 1
601 this.col: number = 1
602 endclass
603
604If you want the constructor to have mandatory arguments, you need to write it
605yourself. For example, if for the AutoNew class above you insist on getting
606the name, you can define the constructor like this: >
607
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000608 def new(this.name, this.age = v:none, this.gender = v:none)
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000609 enddef
Bram Moolenaar65b0d162022-12-13 18:43:22 +0000610< *E1328*
611Note that you cannot use another default value than "v:none" here. If you
612want to initialize the object members, do it where they are declared. This
613way you only need to look in one place for the default values.
Bram Moolenaar7db29e42022-12-11 15:53:04 +0000614
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000615All object members will be used in the default constructor, also private
616access ones.
617
618If the class extends another one, the object members of that class will come
619first.
620
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000621
622Multiple constructors ~
623
624Normally a class has just one new() constructor. In case you find that the
625constructor is often called with the same arguments you may want to simplify
626your code by putting those arguments into a second constructor method. For
627example, if you tend to use the color black a lot: >
628
629 def new(this.garment, this.color, this.size)
630 enddef
631 ...
632 var pants = new(Garment.pants, Color.black, "XL")
633 var shirt = new(Garment.shirt, Color.black, "XL")
634 var shoes = new(Garment.shoes, Color.black, "45")
635
636Instead of repeating the color every time you can add a constructor that
637includes it: >
638
639 def newBlack(this.garment, this.size)
640 this.color = Color.black
641 enddef
642 ...
643 var pants = newBlack(Garment.pants, "XL")
644 var shirt = newBlack(Garment.shirt, "XL")
645 var shoes = newBlack(Garment.shoes, "9.5")
646
647Note that the method name must start with "new". If there is no method called
648"new()" then the default constructor is added, even though there are other
649constructor methods.
650
651
652==============================================================================
653
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00006547. Type definition *Vim9-type* *:type*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000655
656A type definition is giving a name to a type specification. For Example: >
657
658 :type ListOfStrings list<string>
659
660TODO: more explanation
661
662
663==============================================================================
664
Bram Moolenaarbe4e0162023-02-02 13:59:48 +00006658. Enum *Vim9-enum* *:enum* *:endenum*
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000666
667An enum is a type that can have one of a list of values. Example: >
668
669 :enum Color
670 White
671 Red
672 Green
673 Blue
674 Black
675 :endenum
676
677TODO: more explanation
678
679
680==============================================================================
681
6829. Rationale
683
684Most of the choices for |Vim9| classes come from popular and recently
685developed languages, such as Java, TypeScript and Dart. The syntax has been
686made to fit with the way Vim script works, such as using `endclass` instead of
687using curly braces around the whole class.
688
689Some common constructs of object-oriented languages were chosen very long ago
690when this kind of programming was still new, and later found to be
691sub-optimal. By this time those constructs were widely used and changing them
692was not an option. In Vim we do have the freedom to make different choices,
693since classes are completely new. We can make the syntax simpler and more
694consistent than what "old" languages use. Without diverting too much, it
695should still mostly look like what you know from existing languages.
696
697Some recently developed languages add all kinds of fancy features that we
698don't need for Vim. But some have nice ideas that we do want to use.
699Thus we end up with a base of what is common in popular languages, dropping
700what looks like a bad idea, and adding some nice features that are easy to
701understand.
702
703The main rules we use to make decisions:
704- Keep it simple.
705- No surprises, mostly do what other languages are doing.
706- Avoid mistakes from the past.
707- Avoid the need for the script writer to consult the help to understand how
708 things work, most things should be obvious.
709- Keep it consistent.
710- Aim at an average size plugin, not at a huge project.
711
712
713Using new() for the constructor ~
714
715Many languages use the class name for the constructor method. A disadvantage
716is that quite often this is a long name. And when changing the class name all
717constructor methods need to be renamed. Not a big deal, but still a
718disadvantage.
719
720Other languages, such as TypeScript, use a specific name, such as
721"constructor()". That seems better. However, using "new" or "new()" to
722create a new object has no obvious relation with "constructor()".
723
724For |Vim9| script using the same method name for all constructors seemed like
725the right choice, and by calling it new() the relation between the caller and
726the method being called is obvious.
727
728
729No overloading of the constructor ~
730
731In Vim script, both legacy and |Vim9| script, there is no overloading of
732functions. That means it is not possible to use the same function name with
733different types of arguments. Therefore there also is only one new()
734constructor.
735
736With |Vim9| script it would be possible to support overloading, since
737arguments are typed. However, this gets complicated very quickly. Looking at
738a new() call one has to inspect the types of the arguments to know which of
739several new() methods is actually being called. And that can require
740inspecting quite a bit of code. For example, if one of the arguments is the
741return value of a method, you need to find that method to see what type it is
742returning.
743
744Instead, every constructor has to have a different name, starting with "new".
745That way multiple constructors with different arguments are possible, while it
746is very easy to see which constructor is being used. And the type of
747arguments can be properly checked.
748
749
750No overloading of methods ~
751
752Same reasoning as for the constructor: It is often not obvious what type
753arguments have, which would make it difficult to figure out what method is
754actually being called. Better just give the methods a different name, then
755type checking will make sure it works as you intended. This rules out
756polymorphism, which we don't really need anyway.
757
758
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000759Single inheritance and interfaces ~
760
761Some languages support multiple inheritance. Although that can be useful in
762some cases, it makes the rules of how a class works quite complicated.
763Instead, using interfaces to declare what is supported is much simpler. The
764very popular Java language does it this way, and it should be good enough for
Bram Moolenaarbe4e0162023-02-02 13:59:48 +0000765Vim. The "keep it simple" rule applies here.
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000766
767Explicitly declaring that a class supports an interface makes it easy to see
768what a class is intended for. It also makes it possible to do proper type
769checking. When an interface is changed any class that declares to implement
770it will be checked if that change was also changed. The mechanism to assume a
771class implements an interface just because the methods happen to match is
772brittle and leads to obscure problems, let's not do that.
773
774
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000775Using "this.member" everywhere ~
776
777The object members in various programming languages can often be accessed in
778different ways, depending on the location. Sometimes "this." has to be
779prepended to avoid ambiguity. They are usually declared without "this.".
780That is quite inconsistent and sometimes confusing.
781
782A very common issue is that in the constructor the arguments use the same name
783as the object member. Then for these members "this." needs to be prefixed in
784the body, while for other members this is not needed and often omitted. This
785leads to a mix of members with and without "this.", which is inconsistent.
786
787For |Vim9| classes the "this." prefix is always used. Also for declaring the
788members. Simple and consistent. When looking at the code inside a class it's
789also directly clear which variable references are object members and which
790aren't.
791
792
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000793Using class members ~
794
795Using "static member" to declare a class member is very common, nothing new
796here. In |Vim9| script these can be accessed directly by their name. Very
797much like how a script-local variable can be used in a function. Since object
798members are always accessed with "this." prepended, it's also quickly clear
799what kind of member it is.
800
801TypeScript prepends the class name before the class member, also inside the
802class. This has two problems: The class name can be rather long, taking up
803quite a bit of space, and when the class is renamed all these places need to
804be changed too.
805
806
Bram Moolenaar1b5f03e2023-01-09 20:12:45 +0000807Declaring object and class members ~
808
809The main choice is whether to use "var" as with variable declarations.
810TypeScript does not use it: >
811 class Point {
812 x: number;
813 y = 0;
814 }
815
816Following that Vim object members could be declared like this: >
817 class Point
818 this.x: number
819 this.y = 0
820 endclass
821
822Some users pointed out that this looks more like an assignment than a
823declaration. Adding "var" changes that: >
824 class Point
825 var this.x: number
826 var this.y = 0
827 endclass
828
829We also need to be able to declare class members using the "static" keyword.
830There we can also choose to leave out "var": >
831 class Point
832 var this.x: number
833 static count = 0
834 endclass
835
836Or do use it, before "static": >
837 class Point
838 var this.x: number
839 var static count = 0
840 endclass
841
842Or after "static": >
843 class Point
844 var this.x: number
845 static var count = 0
846 endclass
847
848This is more in line with "static def Func()".
849
850There is no clear preference whether to use "var" or not. The two main
851reasons to leave it out are:
8521. TypeScript, Java and other popular languages do not use it.
8532. Less clutter.
854
855
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000856Using "ClassName.new()" to construct an object ~
857
858Many languages use the "new" operator to create an object, which is actually
859kind of strange, since the constructor is defined as a method with arguments,
860not a command. TypeScript also has the "new" keyword, but the method is
861called "constructor()", it is hard to see the relation between the two.
862
863In |Vim9| script the constructor method is called new(), and it is invoked as
864new(), simple and straightforward. Other languages use "new ClassName()",
865while there is no ClassName() method, it's a method by another name in the
866class called ClassName. Quite confusing.
867
868
869Default read access to object members ~
870
871Some users will remark that the access rules for object members are
872asymmetric. Well, that is intentional. Changing a value is a very different
873action than reading a value. The read operation has no side effects, it can
874be done any number of times without affecting the object. Changing the value
875can have many side effects, and even have a ripple effect, affecting other
876objects.
877
878When adding object members one usually doesn't think much about this, just get
879the type right. And normally the values are set in the new() method.
880Therefore defaulting to read access only "just works" in most cases. And when
881directly writing you get an error, which makes you wonder if you actually want
882to allow that. This helps writing code with fewer mistakes.
883
884
Bram Moolenaar00b28d62022-12-08 15:32:33 +0000885Making object members private with an underscore ~
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000886
887When an object member is private, it can only be read and changed inside the
888class (and in sub-classes), then it cannot be used outside of the class.
889Prepending an underscore is a simple way to make that visible. Various
890programming languages have this as a recommendation.
891
892In case you change your mind and want to make the object member accessible
893outside of the class, you will have to remove the underscore everywhere.
894Since the name only appears in the class (and sub-classes) they will be easy
895to find and change.
896
897The other way around is much harder: you can easily prepend an underscore to
898the object member inside the class to make it private, but any usage elsewhere
899you will have to track down and change. You may have to make it a "set"
900method call. This reflects the real world problem that taking away access
901requires work to be done for all places where that access exists.
902
903An alternative would have been using the "private" keyword, just like "public"
904changes the access in the other direction. Well, that's just to reduce the
905number of keywords.
906
907
908No protected object members ~
909
910Some languages provide several ways to control access to object members. The
911most known is "protected", and the meaning varies from language to language.
912Others are "shared", "private" and even "friend".
913
914These rules make life more difficult. That can be justified in projects where
915many people work on the same, complex code where it is easy to make mistakes.
916Especially when refactoring or other changes to the class model.
917
918The Vim scripts are expected to be used in a plugin, with just one person or a
919small team working on it. Complex rules then only make it more complicated,
Bram Moolenaar71badf92023-04-22 22:40:14 +0100920the extra safety provided by the rules isn't really needed. Let's just keep
921it simple and not specify access details.
Bram Moolenaarc1c365c2022-12-04 20:13:24 +0000922
923
924==============================================================================
925
92610. To be done later
927
928Can a newSomething() constructor invoke another constructor? If yes, what are
929the restrictions?
930
931Thoughts:
932- Generics for a class: `class <Tkey, Tentry>`
933- Generics for a function: `def <Tkey> GetLast(key: Tkey)`
934- Mixins: not sure if that is useful, leave out for simplicity.
935
936Some things that look like good additions:
937- For testing: Mock mechanism
938
939An important class to be provided is "Promise". Since Vim is single
940threaded, connecting asynchronous operations is a natural way of allowing
941plugins to do their work without blocking the user. It's a uniform way to
942invoke callbacks and handle timeouts and errors.
943
944
945 vim:tw=78:ts=8:noet:ft=help:norl: