This document introduces the basics of pointers as they work in several computer languages -- C, C++, Java, and Pascal. This document is the companion document for thePointer Fun with Binkydigital video, or it may be used by itself.
This is document 106 in the Stanford CS Education Library. This and other free materials are available atcslibrary.stanford.edu. Some documents that are related to this one include...
Apointerstores a reference to something. Unfortunately there is no fixed term for the thing that the pointer points to, and across different computer languages there is a wide variety of things that pointers point to. We use the termpointeefor the thing that the pointer points to, and we stick to the basic properties of the pointer/pointee relationship which are true in all languages. The term "reference" means pretty much the same thing as "pointer" -- "reference" implies a more high-level discussion, while "pointer" implies the traditional compiled language implementation of pointers as addresses. For the basic pointer/pointee rules covered here, the terms are effectively equivalent.
The above drawing shows a pointer namedx
pointing to a pointee which is storing the value 42. A pointer is usually drawn as a box, and the reference it stores is drawn as an arrow starting in the box and leading to its pointee.
Allocating a pointer and allocating a pointee for it to point to are two separate steps. You can think of the pointer/pointee structure as operating at two levels. Both the levels must be set up for things to work. The most common error is concentrating on writing code which manipulates the pointer level, but forgetting to set up the pointee level. Sometimes pointer operations that do not touch the pointees are called "shallow" while operations on the pointees are called "deep".
The dereference operation on a pointer only works if the pointer has a pointee -- the pointee must be allocated and the pointer must be set to point to it. The most common error in pointer code is forgetting to set up the pointee. The most common runtime crash because of that error in the code is a failed dereference operation. In Java the incorrect dereference will be flagged politely by the runtime system. In compiled languages such as C, C++, and Pascal, the incorrect dereference will sometimes crash, and other times corrupt memory in some subtle, random way. Pointer bugs in compiled languages can be difficult to track down for this reason.
Pointer assignmentbetween two pointers makes them point to the same pointee. So the assignmenty = x;
makesy
point to the same pointee asx
. Pointer assignment does not touch the pointees. It just changes one pointer to have the same reference as another pointer. After pointer assignment, the two pointers are said to be "sharing" the pointee.
1. Allocate two pointersx andy . Allocating the pointersdoes notallocate any pointees. |
|
2. Allocate a pointee and setx to point to it. Each language has its own syntax for this. What matters is that memory is dynamically allocated for one pointee, andx is set to point to that pointee. |
|
3. Dereferencex to store 42 in its pointee. This is a basic example of the dereference operation. Start atx , follow the arrow over to access its pointee. |
|
4. Try to dereferencey to store 13 in its pointee. This crashes becausey does not have a pointee -- it was never assigned one. |
|
5. Assigny = x; so thaty points tox 's pointee. Nowx andy point to the same pointee -- they are "sharing". |
|
6. Try to dereferencey to store 13 in its pointee. This time it works, because the previous assignment gavey a pointee. |
Below are versions of this example inC,Java,C++, andPascal. They all do the same thing -- the syntax is just adjusted for each language.
The pointersx
andy
are allocated as local variables. The typeint*
means "pointer which points to ints". As Binky learns, the pointers do not automatically get pointees. The pointee forx
is dynamically allocated separately with the standard library functionmalloc()
. The syntax*x
dereferences x to access its pointee.
void main() { int* x; // Allocate the pointers x and y int* y; // (but not the pointees) x = malloc(sizeof(int)); // Allocate an int pointee, // and set x to point to it *x = 42; // Dereference x to store 42 in its pointee *y = 13; // CRASH -- y does not have a pointee yet y = x; // Pointer assignment sets y to point to x's pointee *y = 13; // Dereference y to store 13 in its (shared) pointee }
Another way to play with pointers in C (or C++) is using the ampersand (&
) operator to compute a pointer to local memory in the stack. However, pointees dynamically allocated in the heap are the most common, so that's what we show.
IntObj
class that stores one integer. We can then create anIntObj
pointee to store the int. As Binky learns, allocating the pointer with code likeIntObj x;
does not automatically allocate the pointee. TheIntObj
pointee is allocated with a call tonew
. The syntaxx.value
dereferencesx
to access the.value
field in its pointee.
class IntObj { public int value; } public class Binky() { public static void main(String[] args) { IntObj x; // Allocate the pointers x and y IntObj y; // (but not the IntObj pointees) x = new IntObj(); // Allocate an IntObj pointee // and set x to point to it x.value = 42; // Dereference x to store 42 in its pointee y.value = 13; // CRASH -- y does not have a pointee yet y = x; // Pointer assignment sets y to point to x's pointee y.value = 13; // Deference y to store 13 in its (shared) pointee } }
new
is used instead of
malloc()
.
void main() { int* x; // Allocate the pointers x and y int* y; // (but not the pointees) x = new int; // Allocate an int pointee, // and set x to point to it *x = 42; // Dereference x to store 42 in its pointee *y = 13; // CRASH -- y does not have a pointee yet y = x; // Pointer assignment sets y to point to x's pointee *y = 13; // Dereference y to store 13 in its (shared) pointee }
^Integer
means "pointer which points to integers". As Binky learns, allocating the pointer does not automatically allocate its pointee. The standard procedure
New()
takes a pointer argument, allocates a new pointee, and sets the pointer to point to it. The expression
x^
dereferences x to access its pointee.
Procedure main var x:^Integer; /* Allocate the pointers x and y */ var y:^Integer; /* (but not the pointees) */ Begin New(x); /* Allocate a pointee and set x to point to it */ x^ := 42; /* Deference x to store 42 in its pointee */ y^ := 13; /* CRASH -- y does not have a pointee yet */ y := x; /* Pointer assignment makes y point to x's pointee */ y^ := 13; /* Dereference y to store 13 in its (shared) pointee */ End;
These study questions cover review basic features of pointers. Two of the questions make heavy use of memory drawings. Memory drawings are an excellent way to think through pointer problems.
At the end of the above code,y
is set to have a pointee and then dereferenced it store the number 13 into its pointee. After this happens, what is the value ofx
's pointee?
Answer:The value ofx
's pointee is 13 because it is alsoy
's pointee. This is what sharing is all about -- multiple pointers pointing to one pointee.
Consider the following drawing...
Using the language of your choice, write some code that creates the above pointer structure.
Answer:The basic steps are...
{ int* x; int* y; x = malloc(sizeof(int)); y = malloc(sizeof(int)); *x = 1; *y = 2; x = y; } |
{ IntObj x; IntObj y; x = new IntObj(); y = new IntObj(); x.value = 1; y.value = 2; x = y; } |
Suppose you have a pointee type called "Node" which contains two things: an int, and a pointer to another Node (the declaration for such a Node type is given below). With such a pointee type, you could arrange three Node pointees in a structure where they were pointing to each other like this...
The pointer namedx
points to the first Node pointee. The first Node contains a pointer to the second, the second contains a pointer to the third, and the third contains a pointer back to the first. This structure can be build using only the rules of pointee allocation, dereferencing, and assignment that we have seen. Using the declaration below, each Node contains an integer namedvalue
and a pointer to another Node namednext
.
struct Node { int value; struct Node* next; }; |
class Node { public int value; public Node next; }; |
Write the code to build the structure in the above drawing. For convenience, you may use temporary pointers in addition tox
. The only new syntax required is that in C, the operator->
dereferences a pointer to access a field in the pointee -- so->value
accesses the field namedvalue
inx
's pointee.
AnswerThe basic steps are...
y
andz
for the other two Nodes.value
field in its pointee..next
field in its pointee, and use pointer assignment to set the.next
field to point to the appropriate Node. { // Allocate the pointers struct Node* x; struct Node* y; struct Node* z; // Allocate the pointees x = malloc(sizeof(Node)); y = malloc(sizeof(Node)); z = malloc(sizeof(Node)); // Put the numbers in the pointees x->value = 1; y->value = 2; z->value = 3; // Put the pointers in the pointees x->next = y; y->next = z; z->next = x; } |
{ // Allocate the pointers Node x; Node y; Node z; // Allocate the pointees x = new Node(); y = new Node(); z = new Node(); // Put the numbers in the pointees x.value = 1; y.value = 2; z.value = 3; // Put the pointers in the pointees x.next = y; y.next = z; z.next = x; } |
The Node structure introduced here is actually a real data type used to build the "linked list" data structure. Linked lists are a realistic applied use of pointers and are an excellent area to develop your pointer skills. SeeLinked List BasicsandLinked List Problemsin the Stanford CS Education Library for lots of linked list material.
Copyright Nick Parlante, 1999. This material may be copied and redistributed so long as the standard Stanford CS Education Library notice on the first page is retained: "This is document 106 in the Stanford CS Education Library. This and other free materials are available atcslibrary.stanford.edu."
I hope that you benefit from this material in the spirit of goodwill in which it is given. That someone seeking education should have the opportunity to find it.
Up to theCS Education Library Home
Reference:
http://cslibrary.stanford.edu/106/
END