Refactor all destructor functions from free<thing>() -> `destroy<th…

…ing>()` so the autocomplete doesn't collide with system free() Refactor destructor APIs to be a bit neater, they now free the pointer passed in so you don't have to do it yourself.
marcobambini · Feb 3, 2020 · 5a8657b · 5a8657b
1 parent 9b8f3ed
commit 5a8657b
Show file tree

Hide file tree

Showing 20 changed files with 93 additions and 106 deletions.
diff --git a/src/acceleration/kdtree.c b/src/acceleration/kdtree.c
@@ -208,10 +208,10 @@ bool rayIntersectsWithNode(const struct kdTreeNode *node, const struct lightRay
 	return false;
 }
 
-void freeTree(struct kdTreeNode *node) {
+void destroyTree(struct kdTreeNode *node) {
 	if (node) {
-		freeTree(node->left);
-		freeTree(node->right);
+		destroyTree(node->left);
+		destroyTree(node->right);
 		if (node->bbox) free(node->bbox);
 		if (node->polygons) free(node->polygons);
 		free(node);

diff --git a/src/acceleration/kdtree.h b/src/acceleration/kdtree.h
@@ -41,4 +41,4 @@ int checkTree(const struct kdTreeNode *node);
 
 /// Free a given tree
 /// @param node Root node of a tree to free
-void freeTree(struct kdTreeNode *node);
+void destroyTree(struct kdTreeNode *node);
diff --git a/src/c-ray.c b/src/c-ray.c
@@ -53,7 +53,7 @@ void crInitSDL() {
 void crDestroySDL() {
 #ifdef UI_ENABLED
 	ASSERT(grenderer->mainDisplay->window);
-	freeDisplay(grenderer->mainDisplay);
+	destroyDisplay(grenderer->mainDisplay);
 #endif
 }
 
@@ -93,11 +93,8 @@ void crInitRenderer() {
 
 void crDestroyRenderer() {
 	ASSERT(grenderer);
-	freeRenderer(grenderer);
-	if (currentImage) {
-		freeTexture(currentImage);
-		free(currentImage);
-	}
+	destroyRenderer(grenderer);
+	destroyTexture(currentImage);
 }
 
 int crLoadSceneFromFile(char *filePath) {

diff --git a/src/datatypes/camera.c b/src/datatypes/camera.c
@@ -50,8 +50,9 @@ void transformCameraIntoView(struct camera *cam) {
 	transformCameraView(cam, &cam->up);
 }
 
-void freeCamera(struct camera *cam) {
+void destroyCamera(struct camera *cam) {
 	if (cam->transforms) {
 		free(cam->transforms);
+		free(cam);
 	}
 }
diff --git a/src/datatypes/camera.h b/src/datatypes/camera.h
@@ -30,4 +30,4 @@ void initCamera(struct camera *cam);
 void transformCameraView(struct camera *cam, struct vector *direction); //For transforming direction in renderer
 void transformCameraIntoView(struct camera *cam); //Run once in scene.c to calculate pos, up, left
 
-void freeCamera(struct camera *cam);
+void destroyCamera(struct camera *cam);
diff --git a/src/datatypes/material.c b/src/datatypes/material.c
@@ -338,7 +338,7 @@ bool dialectricBSDF(struct hitRecord *isect, const struct lightRay *ray, struct
 	return true;
 }
 
-void freeMaterial(struct material *mat) {
+void destroyMaterial(struct material *mat) {
 	if (mat->textureFilePath) {
 		free(mat->textureFilePath);
 	}
@@ -349,9 +349,6 @@ void freeMaterial(struct material *mat) {
 		free(mat->name);
 	}
 	if (mat->hasTexture) {
-		if (mat->texture) {
-			freeTexture(mat->texture);
-			free(mat->texture);
-		}
+		destroyTexture(mat->texture);
 	}
 }
diff --git a/src/datatypes/material.h b/src/datatypes/material.h
@@ -120,4 +120,4 @@ bool dialectricBSDF(struct hitRecord *isect, const struct lightRay *ray, struct
 
 void assignBSDF(struct material *mat);
 
-void freeMaterial(struct material *mat);
+void destroyMaterial(struct material *mat);
diff --git a/src/datatypes/mesh.c b/src/datatypes/mesh.c
@@ -58,7 +58,7 @@ void transformMesh(struct mesh *mesh) {
 	free(ntformed);
 }
 
-void freeMesh(struct mesh *mesh) {
+void destroyMesh(struct mesh *mesh) {
 	if (mesh->name) {
 		free(mesh->name);
 	}
@@ -68,11 +68,11 @@ void freeMesh(struct mesh *mesh) {
 		}
 	}
 	if (mesh->tree) {
-		freeTree(mesh->tree);
+		destroyTree(mesh->tree);
 	}
 	if (mesh->materials) {
 		for (int i = 0; i < mesh->materialCount; i++) {
-			freeMaterial(&mesh->materials[i]);
+			destroyMaterial(&mesh->materials[i]);
 		}
 		free(mesh->materials);
 	}

diff --git a/src/datatypes/mesh.h b/src/datatypes/mesh.h
@@ -51,4 +51,4 @@ struct mesh {
 void addTransform(struct mesh *mesh, struct transform transform);
 void transformMesh(struct mesh *mesh);
 
-void freeMesh(struct mesh *mesh);
+void destroyMesh(struct mesh *mesh);
diff --git a/src/datatypes/scene.c b/src/datatypes/scene.c
@@ -130,23 +130,21 @@ int loadScene(struct renderer *r, char *input) {
 }
 
 //Free scene data
-void freeScene(struct world *scene) {
-	if (scene->hdr) {
-		freeTexture(scene->hdr);
-		free(scene->hdr);
-	}
-
-	if (scene->meshes) {
-		for (int i = 0; i < scene->meshCount; i++) {
-			freeMesh(&scene->meshes[i]);
+void destroyScene(struct world *scene) {
+	if (scene) {
+		destroyTexture(scene->hdr);
+		if (scene->meshes) {
+			for (int i = 0; i < scene->meshCount; i++) {
+				destroyMesh(&scene->meshes[i]);
+			}
+			free(scene->meshes);
 		}
-		free(scene->meshes);
-	}
-	if (scene->spheres) {
-		free(scene->spheres);
-	}
-	if (scene->camera) {
-		freeCamera(scene->camera);
-		free(scene->camera);
+		if (scene->spheres) {
+			free(scene->spheres);
+		}
+		if (scene->camera) {
+			destroyCamera(scene->camera);
+		}
+		free(scene);
 	}
 }
diff --git a/src/datatypes/scene.h b/src/datatypes/scene.h
@@ -35,4 +35,4 @@ struct world {
 
 int loadScene(struct renderer *r, char *input);
 
-void freeScene(struct world *scene);
+void destroyScene(struct world *scene);
diff --git a/src/datatypes/texture.c b/src/datatypes/texture.c
@@ -95,7 +95,7 @@ struct texture *newTexture(enum precision p, int width, int height, int channels
 			t->byte_data = calloc(channels * width * height, sizeof(unsigned char));
 			if (!t->byte_data) {
 				logr(warning, "Failed to allocate %ix%i texture.\n", width, height);
-				freeTexture(t);
+				destroyTexture(t);
 				return NULL;
 			}
 		}
@@ -104,7 +104,7 @@ struct texture *newTexture(enum precision p, int width, int height, int channels
 			t->float_data = calloc(channels * width * height, sizeof(float));
 			if (!t->float_data) {
 				logr(warning, "Failed to allocate %ix%i texture.\n", width, height);
-				freeTexture(t);
+				destroyTexture(t);
 				return NULL;
 			}
 		}
@@ -135,17 +135,20 @@ void textureToSRGB(struct texture *t) {
 	t->colorspace = sRGB;
 }
 
-void freeTexture(struct texture *t) {
-	if (t->fileName) {
-		free(t->fileName);
-	}
-	if (t->filePath) {
-		free(t->filePath);
-	}
-	if (t->byte_data) {
-		free(t->byte_data);
-	}
-	if (t->float_data) {
-		free(t->float_data);
+void destroyTexture(struct texture *t) {
+	if (t) {
+		if (t->fileName) {
+			free(t->fileName);
+		}
+		if (t->filePath) {
+			free(t->filePath);
+		}
+		if (t->byte_data) {
+			free(t->byte_data);
+		}
+		if (t->float_data) {
+			free(t->float_data);
+		}
+		free(t);
 	}
 }
diff --git a/src/datatypes/texture.h b/src/datatypes/texture.h
@@ -66,4 +66,4 @@ void textureFromSRGB(struct texture *t);
 /// @param t Texture to convert
 void textureToSRGB(struct texture *t);
 
-void freeTexture(struct texture *tex);
+void destroyTexture(struct texture *tex);
diff --git a/src/datatypes/vertexbuffer.c b/src/datatypes/vertexbuffer.c
@@ -27,7 +27,20 @@ int normalCount;
 struct coord *textureArray;
 int textureCount;
 
-void freeVertexBuffer() {
+void allocVertexBuffer() {
+	ASSERT(!vertexArray);
+	vertexArray = calloc(1, sizeof(struct vector));
+	normalArray = calloc(1, sizeof(struct vector));
+	textureArray = calloc(1, sizeof(struct coord));
+	polygonArray = calloc(1, sizeof(struct poly));
+
+	vertexCount = 0;
+	normalCount = 0;
+	textureCount = 0;
+	polyCount = 0;
+}
+
+void destroyVertexBuffer() {
 	if (vertexArray) {
 		free(vertexArray);
 	}
@@ -41,16 +54,3 @@ void freeVertexBuffer() {
 		free(polygonArray);
 	}
 }
-
-void allocVertexBuffer() {
-	ASSERT(!vertexArray);
-	vertexArray = calloc(1, sizeof(struct vector));
-	normalArray = calloc(1, sizeof(struct vector));
-	textureArray = calloc(1, sizeof(struct coord));
-	polygonArray = calloc(1, sizeof(struct poly));
-
-	vertexCount = 0;
-	normalCount = 0;
-	textureCount = 0;
-	polyCount = 0;
-}
diff --git a/src/datatypes/vertexbuffer.h b/src/datatypes/vertexbuffer.h
@@ -19,4 +19,4 @@ extern struct coord *textureArray;
 extern int textureCount;
 
 void allocVertexBuffer(void);
-void freeVertexBuffer(void);
+void destroyVertexBuffer(void);
diff --git a/src/renderer/renderer.c b/src/renderer/renderer.c
@@ -348,32 +348,22 @@ struct renderer *newRenderer() {
 	return r;
 }
 
-void freeRenderer(struct renderer *r) {
+void destroyRenderer(struct renderer *r) {
 	if (r->state.timer) {
 		free(r->state.timer);
 	}
-	if (r->scene) {
-		freeScene(r->scene);
-		free(r->scene);
-	}
+	destroyScene(r->scene);
 	if (r->state.renderTiles) {
 		free(r->state.renderTiles);
 	}
-	if (r->state.renderBuffer) {
-		freeTexture(r->state.renderBuffer);
-		free(r->state.renderBuffer);
-	}
-	if (r->state.uiBuffer) {
-		freeTexture(r->state.uiBuffer);
-		free(r->state.uiBuffer);
-	}
+
+	destroyTexture(r->state.renderBuffer);
+	destroyTexture(r->state.uiBuffer);
+
 	if (r->state.threadStates) {
 		free(r->state.threadStates);
 	}
-	if (r->mainDisplay) {
-		freeDisplay(r->mainDisplay);
-		free(r->mainDisplay);
-	}
+	destroyDisplay(r->mainDisplay);
 	if (r->prefs.imgFileName) {
 		free(r->prefs.imgFileName);
 	}
@@ -382,7 +372,7 @@ void freeRenderer(struct renderer *r) {
 	}
 
 	if (vertexArray) {
-		freeVertexBuffer();
+		destroyVertexBuffer();
 	}
 
 	free(r);

diff --git a/src/renderer/renderer.h b/src/renderer/renderer.h
@@ -110,4 +110,4 @@ struct renderer *newRenderer(void);
 struct texture *renderFrame(struct renderer *r);
 
 //Free renderer allocations
-void freeRenderer(struct renderer *r);
+void destroyRenderer(struct renderer *r);
diff --git a/src/utils/loaders/textureloader.c b/src/utils/loaders/textureloader.c
@@ -55,8 +55,7 @@ struct texture *loadTexture(char *filePath) {
 		new->float_data = stbi_loadf(filePath, (int*)&new->width, (int*)&new->height, &new->channels, 0);
 		new->precision = float_p;
 		if (!new->float_data) {
-			freeTexture(new);
-			free(new);
+			destroyTexture(new);
 			logr(warning, "Error while loading HDR from %s - Does the file exist?\n");
 			return NULL;
 		}
@@ -66,8 +65,7 @@ struct texture *loadTexture(char *filePath) {
 		new->byte_data = stbi_load(filePath, (int*)&new->width, (int*)&new->height, &new->channels, 3);
 		if (!new->byte_data) {
 			logr(warning, "Error while loading texture from %s - Does the file exist?\n", filePath);
-			freeTexture(new);
-			free(new);
+			destroyTexture(new);
 			return NULL;
 		}
 		new->fileType = buffer;

diff --git a/src/utils/ui.c b/src/utils/ui.c
@@ -93,19 +93,22 @@ int initSDL(struct display *d) {
 	return 0;
 }
 
-void freeDisplay(struct display *d) {
+void destroyDisplay(struct display *d) {
 #ifdef UI_ENABLED
-	if (d->window) {
-		SDL_DestroyWindow(d->window);
-	}
-	if (d->renderer) {
-		SDL_DestroyRenderer(d->renderer);
-	}
-	if (d->texture) {
-		SDL_DestroyTexture(d->texture);
-	}
-	if (d->overlayTexture) {
-		SDL_DestroyTexture(d->overlayTexture);
+	if (d) {
+		if (d->window) {
+			SDL_DestroyWindow(d->window);
+		}
+		if (d->renderer) {
+			SDL_DestroyRenderer(d->renderer);
+		}
+		if (d->texture) {
+			SDL_DestroyTexture(d->texture);
+		}
+		if (d->overlayTexture) {
+			SDL_DestroyTexture(d->overlayTexture);
+		}
+		free(d);
 	}
 #endif
 }

diff --git a/src/utils/ui.h b/src/utils/ui.h
@@ -33,7 +33,7 @@ struct display {
 };
 
 int initSDL(struct display *d);
-void freeDisplay(struct display *d);
+void destroyDisplay(struct display *d);
 
 void printDuration(uint64_t ms);
 void getKeyboardInput(struct renderer *r);