Pointers in Objective-C

Pointers play a significant role in Objective-C programming and, while their concepts are numerous, they are relatively straightforward to understand. Below are some key pointer concepts that every Objective-C programmer should be familiar with:

1. Pointer Arithmetic
2. Array of Pointers
3. Pointer to Pointer
4. Passing Pointers to Functions 
5. Returning Pointers from Functions

1. Pointer Arithmetic

Pointers in Objective-C store the memory address of variables. This allows for arithmetic operations on pointers using operators like ++, --, +, and -. Consider a pointer to an integer, which is located at address 1000. If the integer is 32-bits, performing the following pointer arithmetic operations will result in the pointer advancing by the size of the data type it points to (in this case, 4 bytes for an integer). Let’s explore different pointer arithmetic operations:

i. Increment of a Pointer: When a pointer is incremented, it moves by the size of the data type it is pointing to. For instance, if an integer pointer starts at address 2000, after incrementing by 4 (size of an integer), the new address it points to will be 2004.

Example:

#import <Foundation/Foundation.h>

int main() {
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    int arr[5] = {10, 20, 30, 40, 50};
    int *ptr = arr;

    for (int i = 0; i < 5; i++) {
        NSLog(@"Pointer Arithmetic = %d", *ptr++);
    }

    [pool drain];
    return 0;
}

Output:

Pointer Arithmetic = 10
Pointer Arithmetic = 20
Pointer Arithmetic = 30
Pointer Arithmetic = 40
Pointer Arithmetic = 50

ii. Decrement of a Pointer: When a pointer is decremented, it moves backwards by the size of the data type it is pointing to. For example, if an integer pointer is at address 2000, after decrementing by 4, the pointer will point to address 1996.

Example:

#import <Foundation/Foundation.h>

const int MAX = 5;

int main() {
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    int arr[] = {10, 20, 30, 40, 50};
    int *ptr = &arr[MAX - 1];

    for (int i = MAX; i > 0; i--) {
        NSLog(@"Pointer Arithmetic = %d", *ptr--);
    }

    [pool drain];
    return 0;
}

Output:

Pointer Arithmetic = 50
Pointer Arithmetic = 40
Pointer Arithmetic = 30
Pointer Arithmetic = 20
Pointer Arithmetic = 10

iii. Addition of an Integer to a Pointer: When an integer is added to a pointer, the pointer’s address increases by the product of the integer and the size of the data type it is pointing to. For example, adding 2 to a pointer will result in the pointer moving forward by 2 times the size of the data type it points to.

#import <Foundation/Foundation.h>

int main() {
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    int a = 10, *ptr = &a;
    NSLog(@"Address of ptr: %p", ptr);

    ptr = ptr + 2;
    NSLog(@"Address of ptr after addition: %p", ptr);

    [pool drain];
    return 0;
}

Output:

Address of ptr: 0x7ffee2b93c7c
Address of ptr after addition: 0x7ffee2b93c84

iv. Subtraction of an Integer from a Pointer: When an integer is subtracted from a pointer, the pointer’s address decreases by the product of the integer and the size of the data type it is pointing to.

Example:

#import <Foundation/Foundation.h>

int main() {
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    int a = 10, *ptr = &a;
    NSLog(@"Address of ptr: %p", ptr);

    ptr = ptr - 2;
    NSLog(@"Address of ptr after subtraction: %p", ptr);

    [pool drain];
    return 0;
}

Output:

Address of ptr: 0x7ffee2b93c7c
Address of ptr after subtraction: 0x7ffee2b93c74

Using Pointers to Traverse an Array

Pointers can also be used to access and traverse arrays, where the array’s name acts as a pointer to its first element. For instance, an array arr can be assigned to a pointer, and we can iterate over the array elements using pointer arithmetic.

Example:

#import <Foundation/Foundation.h>

int main() {
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];

    int arr[3] = {5, 8, 9};
    int *ptr = arr;

    for (int i = 0; i < 3; i++) {
        NSLog(@"Value of ptr[%d]: %d", i, *(ptr + i));
    }

    [pool drain];
    return 0;
}

Output:

Value of ptr[0]: 5
Value of ptr[1]: 8
Value of ptr[2]: 9

2. Array of Pointers

In Objective-C, pointers to arrays are used to store multiple values of the same data type in contiguous memory locations. These pointers allow for dynamic memory management and flexible array manipulation, such as passing arrays to functions or returning them from functions. Additionally, pointers to arrays enable you to allocate memory for arrays during runtime, providing more control over memory usage.

Arrays in Objective-C can be categorized into different types. Understanding how to work with them using pointers is crucial for writing effective code. The following are common array types and examples:

Types of Arrays in Objective-C

i. Static Arrays: A static array is defined with a fixed size, and its size cannot be changed during runtime.

Example:

int staticArray[5] = {1, 2, 3, 4, 5};

ii. Dynamic Arrays: A dynamic array’s size can be changed at runtime by allocating memory with the malloc function.

Example:

int *dynamicArray = (int *)malloc(5 * sizeof(int));

iii. Two-Dimensional Arrays: These arrays are essentially arrays of arrays, similar to a matrix or table.

Example:

int twoDimensionalArray[3][3] = {{1, 2, 3}, {4, 5, 6}, {7, 8, 9}};

iv.  Character Arrays: A character array stores strings in Objective-C.

Example:

char name[5] = "John";

v. NSArray: NSArray is an Objective-C class that provides an array-based data structure. It can be initialized with various methods, such as arrayWithObjects: and arrayWithContentsOfFile:.

Example:

NSArray *fruits = [NSArray arrayWithObjects:@"Apple", @"Banana", @"Cherry", nil];

vi.  NSMutableArray: NSMutableArray is a subclass of NSArray that allows modification of the array (adding, removing, or replacing elements).

Example:

NSMutableArray *colors = [NSMutableArray arrayWithObjects:@"Red", @"Green", @"Blue", nil];
[colors addObject:@"Yellow"];
[colors removeObjectAtIndex:2];

Example: Printing Elements of an NSArray

This example defines a pointer to an array of int values and prints the elements of the array.

#import <Foundation/Foundation.h>
#include <stdio.h>
#include <stdlib.h>

int main(int argc, const char * argv[]) {
   @autoreleasepool {
       // Create an NSArray with integer values
       NSArray *array = @[@1, @2, @3, @4, @5];

       // Print the elements of the array
       for (int i = 0; i < [array count]; i++) {
           NSLog(@"%d", [array[i] intValue]);
       }
   }
   return EXIT_SUCCESS;
}

Output:

1
2
3
4
5

Example 2: Summing Elements of an NSArray

This example defines a function that takes a pointer to an array of integers and calculates the sum of the elements.

#import <Foundation/Foundation.h>
#include <stdio.h>
#include <stdlib.h>

int main() {
   @autoreleasepool {
       // Create an NSArray with integer values
       NSArray *array = @[@1, @2, @3, @4, @5];

       // Initialize sum to 0
       int sum = 0;

       // Loop through the elements and calculate the sum
       for (int i = 0; i < [array count]; i++) {
           sum += [array[i] intValue];
       }
       NSLog(@"The sum of the elements is %d", sum);
   }
   return EXIT_SUCCESS;
}

Output:

The sum of the elements is 15

3. Pointer to Pointer

Pointers in Objective-C are an essential concept for manipulating data directly in memory. A pointer to a pointer, also referred to as a double pointer, is a special type of pointer that stores the address of another pointer. This concept is often used when you need to pass a pointer to a function or to manage dynamically allocated memory.

There are three main types of pointers in Objective-C:

i. Regular Pointer: A pointer that holds the address of a variable.

ii. Pointer to Constant: A pointer that holds the address of a constant value.

iii. Constant Pointer: A pointer that holds a constant address, which cannot be changed.

Pointer to Pointer (Double Pointer)

A pointer to a pointer, or double pointer, stores the address of another pointer. It is declared by using two asterisks (**) in the declaration. The first asterisk represents the type of data the pointer is pointing to, while the second asterisk indicates that it is a pointer to another pointer.

Syntax:

data_type **pointer_name;

For example, a double pointer for integers would be declared as:

int **p;

A double pointer allows access to the value stored at the address of the pointer it holds. This involves using &, *, and ** operators. The & operator is used to get the address of a variable, the * operator is used to access the value stored at the address held by the pointer, and ** is used to access the value stored at the address held by the pointer to a pointer.

Example 1: Swapping Two Pointers Using Pointer to Pointer

This example demonstrates how to use a pointer to pointer to swap the values of two variables by passing pointers to a function.

#import <Foundation/Foundation.h>

// Function to swap values using pointers to pointers
void swap(int **p, int **q) {
    int *temp = *p; // Store the value of *p in a temporary variable
    *p = *q;         // Assign the value of *q to *p
    *q = temp;       // Assign the value of temp to *q
}

int main(int argc, const char * argv[]) {
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    // Declare two integer variables
    int a = 10, b = 20;

    // Declare pointers to hold the addresses of a and b
    int *p = &a, *q = &b;

    NSLog(@"Before Swapping");
    NSLog(@"Value of a = %d", a);
    NSLog(@"Value of b = %d", b);

    // Call the swap function, passing the addresses of p and q
    swap(&p, &q);

    NSLog(@"\nAfter Swapping");
    NSLog(@"Value of a = %d", *p);
    NSLog(@"Value of b = %d", *q);

    [pool drain];
    return 0;
}

Output:

Before Swapping
Value of a = 10
Value of b = 20

After Swapping
Value of a = 20
Value of b = 10

Example 2: Using Pointer to Pointer for Dynamic Memory Allocation

In this example, a pointer to pointer is used to dynamically allocate memory for an integer.

#import <Foundation/Foundation.h>

int main() {
    // Declare an integer variable
    int i = 5;

    // Pointer to an integer
    int *p;

    // Pointer to a pointer to an integer
    int **q;

    // Store the address of i in p
    p = &i;

    // Store the address of p in q
    q = &p;

    // Display values stored in i, p, and q
    NSLog(@"Value stored at i = %d", i);
    NSLog(@"Value stored at *p = %d", *p);
    NSLog(@"Value stored at **q = %d", **q);

    return 0;
}

Output:

Value stored at i = 5
Value stored at *p = 5
Value stored at **q = 5

4. Passing Pointers to Functions

Pointers are an essential feature in Objective-C, allowing you to manipulate data stored in memory directly. Passing pointers to functions is a powerful technique that optimizes memory usage, reduces function call overhead, and improves code performance. In Objective-C, pointers are used to pass values to functions and retrieve results from functions.

Types of Pointers

In Objective-C, pointers can be categorized as:

i. Constant Pointers: These pointers cannot be changed once initialized.
2. Non-Constant Pointers: These pointers can have their values modified during the program’s execution.

-(void) sampleFunction:(int *) inputPointer;
-(int *) sampleFunctionOutput;

Pointers are further divided into:

• Input Pointers: These pointers are used to pass data to functions.
• Output Pointers: These pointers are used to return data from functions.

Syntax

-(void) sampleFunction:(int *) inputPointer;
-(int *) sampleFunctionOutput;

Example 1: Passing a Pointer to a Function

In this example, we demonstrate how to pass a pointer to a function and modify the value of the variable it points to.

#import <Foundation/Foundation.h>

@interface SampleClass : NSObject

// Declare a method that accepts an int pointer as an argument
-(void) sampleFunction:(int *) inputPointer;

@end

@implementation SampleClass

-(void) sampleFunction:(int *) inputPointer {
    // Modify the value that inputPointer points to
    *inputPointer = 20;
}

@end

int main() {
    int sampleValue = 10;

    // Create a pointer to sampleValue
    int *inputPointer = &sampleValue;
    SampleClass *obj = [[SampleClass alloc] init];

    // Pass the pointer to the function
    [obj sampleFunction:inputPointer];

    // Print the value of sampleValue after function call
    printf("Value after passing to function: %d\n", sampleValue);
    return 0;
}

Output:

Value after passing to function: 20

5. Return Pointer From Functions​

A pointer is a variable or constant that stores the memory address of another variable. It must be declared before it can hold the address of a variable. The primary advantage of using pointers is that they help optimize program memory, provide direct access to memory locations, and enable faster program execution by allowing efficient data manipulation. Pointers also facilitate dynamic memory allocation, making them essential for file handling. Through pointers, we can symbolically represent memory locations. It is important to declare a pointer before using it to store an address.

Returning a Pointer from Functions

In Objective-C, like in other programming languages, you can return a pointer from user-defined functions. For this, you need to define a function that returns a pointer to a variable. The pointer’s data type must match the return type of the function. Also, the function used to return a pointer cannot have a void return type, even if the pointer to be returned is null.

data_type* demoFunction() {
    // function code
}

Example:

#import <Foundation/Foundation.h>

/* Declaring a global variable */
int number = 10;

/* Function to return a pointer to a variable */
int* getPointer() {
    int *ptr;
    ptr = &number;  // Assigning address of 'number' to pointer
    return ptr;     // Returning the pointer
}

int main() {
    // Declaring a pointer of type int
    int *ptr;

    // Calling the function and storing the returned pointer in 'ptr'
    ptr = getPointer();

    // Dereferencing the pointer to access the value it points to
    NSLog(@"The value pointed to by ptr is %d.", *ptr);

    return 0;
}

Output:

The value pointed to by ptr is 10.