Repository navigation
Expand file tree
/
Copy pathreference.cpp
More file actions
525 lines (409 loc) · 13.3 KB
/
Copy pathreference.cpp
File metadata and controls
525 lines (409 loc) · 13.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
/*
# Reference
# &
Basically aliases, similar to `int* const` pointers or Java objects.
Useful only for function arguments or / return values. In that case the pros are:
- callers that have an object don't need to dereference it with `&`
- it is self documenting on the code that the given reference always points to the same thing
either to modify it or to pass it efficiently without copy.
The cons are:
- callers don't know without looking at the signature if they are passing references or copies,
and whether they should expect that it is possible that the function modifies their object.
- http://stackoverflow.com/questions/7058339/c-when-to-use-references-vs-pointers
# Return reference from function
Just like for pointers, you have to watch scope. If the original object dies,
you get a dangling reference
- http://stackoverflow.com/questions/752658/is-the-practice-of-returning-a-c-reference-variable-evil
There is also some rule about const local references:
- http://stackoverflow.com/questions/2784262/does-a-const-reference-prolong-the-life-of-a-temporary
*/
#include "common.hpp"
int getInt() { return 0; }
std::string getString() { return "abc"; }
/*
int& getIntRef() {
int i = 0;
return i;
}
*/
// WARN: reference to local var returned
/*
OK the returned i reference is not local
*/
int& getIntRef(int& i) {
i++;
return i;
}
/*
The returned i reference cannot be modified.
TODO use
*/
const int& getIntConstRef(int& i) {
i++;
return i;
}
class Class {
public:
int iPublic;
int& getRefIPublic() {return this->iPublic;}
/// Value cannot be changed.
const int& getPrivateConstRef() const {return this->iPrivate;}
// ERROR: const method cannot return noncosnt pointer!
//int* getPrivateAddress() const {return &this->iPrivate;}
const int* getPrivateAddressConst() const {return &this->iPrivate;}
// Value can be changed
int& getPrivateRef() { return this->iPrivate; }
// ERROR: const method cannot return noncosnt reference!
//int& getPrivateRef() const {return this->iPrivate;}
private:
int iPrivate;
};
// Pass by reference.
//http://stackoverflow.com/questions/114180/pointer-vs-reference
void byref(int& i) {i++;}
void bypointer(int *i) {(*i)++;}
void bypointerConst(const int*& ip, const int*& jp) {
ip = jp;
}
int main() {
// Basic usage as function parameters that are return values.
{
int i = 0;
byref(i);
assert(i == 1);
}
/*
References have the same address of the variables.
Therefore:
- if declared inside the same function as the value, no extra memory / dereferencing
needs to be used for references, the compiler can figure everything out at compile time.
- if declared as function arguments, references may be implemented as implicit pointers passing,
sharing therefore the disadvantages of pointers.
Therefore, if you want to be sure of efficiency, pass built-in types by value and not by reference.
*/
{
// They have the same address.
{
int i = 0;
int& ia = i;
ia = 1;
assert(i == 1);
assert(&i == &ia);
}
/*
For the same reason, it is possible to initialize a reference from another reference.
*/
{
int i = 0;
int& ia = i;
int& ia2 = ia;
ia2 = 2;
assert(i == 2);
}
}
/*
ERROR: Must not initialize non-const ref with a rvalue.
Can however do that for const references.
The same goes for function parameters.
*/
{
//int& ia = 0;
//std::string& s = getString();
const std::string& s = getString();
//byref(1);
}
/*
ERROR: references must be initialized imediatelly
otherwise, how can they be initalized in the future?
For references in constructors, they must be initialized at the initialization list.
*/
{
//int& ia;
}
/*
It is possible to get references from pointers.
*/
{
int i = 0;
int* ip = &i;
int& ia = *ip;
ia = 1;
assert(i == 1);
// ERROR: & must get a variable/dereferenced pointer, not pointers themselves!
{
//int& ia = &i;
}
}
/* It is not possible to make an array of references. */
{
int i = 1;
int j = 2;
// ERROR: array of references forbidden
//int& is[2] = {i,i};
}
/*
# const references
References that do not allow one to modify the value of the variable.
*/
{
//it is possible to make a const reference from a non-const object
{
int i = 1;
const int& cia = i;
// ERROR: const references cannot be modified
//cia = 2;
}
//it is possible to make a const reference form a const object
{
const int ci = 1;
const int& cia = ci;
// ERROR: const references cannot be modified
//cia = 2;
}
/*
The rules imposed by the compiler make sure that it is hard or impossible to cheat references by mistake.
*/
{
int i = 1;
const int& cia = i;
// ERROR: invalid conversion
//int& ia = cia;
// ERROR: invalid conversion
//int *ip = &cia;
}
/*
const references can be initialized by rvalues!
This cannot be wrong since they cannot be modified,
so it is not possible to modify the non-existent variable.
In this case what happens is that a simple copy takes place.
One case in which this rule is very important is parameter passing to functions.
For exapmle, the following would be bad:
void f(int& i) {
i++;
}
...
f(1);
//does not compile
and is impossible, but:
void f(const int& i) {
//i++;
//impossible
}
f(1);
is ok, since it is impossible to change i in the function if it is const
*/
{
//initialization from a literal
{
const int& i = 1;
assert(i == 1);
}
/*
Initialization from a non-reference function return.
Functions that return references return lvalues,
so an example with such a function would not be meaningful.
*/
{
const int& i = getInt();
assert(i == 0);
}
}
}
/*
# reference to pointer
like for other variable, references can be made to pointer variables.
*/
{
{
int i = 0;
int j = 1;
int *ip = &i;
int *jp = &j;
int*& ipa = ip;
int*& jpa = jp;
jpa = ip;
//now `jp` is the same as `ip`!
*jp = 2;
assert(i == 2);
//therefore modifying what `jp` points to modifies `i`!
// ERROR: makes no sense: cannot have a pointer to `int&`
//int&* ipaBad = ip;
// ERROR: `&i` is an rvalue. Cannot initialize a non const reference to it.
//int&* ipaBad = &i;
}
/*
# reference to pointer and const
Just like for pointers to pointers in C, the rules prevent `const` variables
from being modified.
*/
{
/*
Obviously, cannot remove const qualifiers, or it would be easy to modify constants.
*/
{
const int c = 0;
const int *ip = &c;
//int *&ipa = ip;
//int *ipa = ip;
//*ipa = 1;
}
/*
`const int*& = int*` initialization fails for the same reason that `const int* = (int*)` fails in C:
this would allow for constant modification.
*/
{
//If (1) were possible below, then it would be possible to change the value of the constant c.
{
/*
int *ip = NULL;
const int*& ipa = ip; // (1) THIS is not possible
const int c = 0;
ipa = &c; // OK because ipa is const. `ip` points to `c`
*ip = 1; // OK because ip is not const
*/
}
/*
This is different without the reference, because in this case
it would not be possible to change the const variable.
Just like in C, the issues only show up in pointer dimensions > 1,
and the reference behaves like a pointer.
*/
{
int *ip = NULL;
const int* ipa = ip; // (1) THIS is ok without the reference, a new pointer is created
const int c = 0;
ipa = &c; // OK because ipa is const. ip still points to NULL
//*ip = 1; // does not change the constant, ip still points to NULL
}
}
}
/*
What to do if:
- a function modifies what pointers point to but not the object pointed to.
It therefore takes
- we want to pass pointers to that function, modify what they point to,
and then outside of the function modify the object being pointed to?
Is this a valid use case for `const_cast`?
*/
{
//the motivation: functions
{
int i = 0;
int j = 1;
int *ip = &i;
int *jp = &j;
//const int *ip = &i;
//const int *jp = &j;
//if those were const, the function call would work,
//but not the `*ip = 2`;
//bypointerConst(ip, jp);
//cannot initialize `const int*&` with `int*&`.
*ip = 2;
//assert(j == 2);
}
//same problem simplified without functions
{
int i = 0;
int *ip = &i;
//int*& ipa = ip;
//possible
//const int*& ipa = ip;
//TODO why is this not possible
}
//but this is possible?
{
int i = 0;
const int& ia = i;
}
}
}
/*
Single line initialization syntax.
Like the pointer symbol `*`, the reference symbol `&` needs to be duplicated for each new reference variable.
*/
{
//ok: both ia and ja are references
{
int i = 1;
int j = 2;
int &ia = i, &ja = j;
ia = -1;
ja = -2;
assert(i == -1);
assert(j == -2);
}
//ko: ja is a new int, not a reference
{
int i = 1;
int j = 2;
int& ia = i, ja = j;
ia = -1;
ja = -2;
assert(i == -1);
assert(j == 2);
}
//with references to pointers it looks like this
{
int i = 0;
int j = 1;
int *ip = &i;
int *jp = &j;
int *& ipa = ip, *& jpa = jp;
jpa = ip;
*jp = 2;
assert(i == 2);
}
}
/*
# return reference from function
Just like when returning pointers from functions,
one must take care not to return dangling references.
*/
{
/*
One simple case in which lifetime is simple to guarantee is
returning members from objects which the callee owns. For example:
*/
{
Class c;
int& ia = c.getRefIPublic();
ia = 0;
assert(c.iPublic == 0);
ia = 1;
assert(c.iPublic == 1);
}
// You can modify a private if you non const reference to it
{
Class c;
int& ia = c.getPrivateRef();
ia = 0;
assert(c.getPrivateRef() == 0);
ia = 1;
assert(c.getPrivateRef() == 1);
}
// If the reference is const it does not work anymore.
{
Class c;
{
const int& ia = c.getPrivateConstRef();
//ia = 1;
}
// ERROR: invalid initialization
{
//int& ia = c.getPrivateConstRef();
}
}
/*
In C, all functions return rvalues,
although if a function returns a pointer and that pointer is dereferenced it becomes an lvalue,
so the following works:
(*ret_int_ptr()) = 1;
In C++, there is an exception: all functions that return references return lvalues directly.
*/
{
int i = 0;
(getIntRef(i)) = 2;
assert(i == 2);
}
}
}