Skip to contentSkip to conversation

tsearch.3: Simplify type usage and remove unneeded casts

PATCH Superseded Alejandro Colomar 3 participants 7 messages Sep 5, 2020 – Sep 8, 2020 Man-pages: manual pages for Linux -- Sections 2, 3, 4, 5, and 7

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tsearch.3: Simplify type usage and remove unneeded casts

The type of var is int **, and it will work with tsearch() anyway because of implicit cast from void *, so declaring it as an int ** simplifies the code.

---
 man3/tsearch.3 | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
man3/tsearch.3 +2 -3
index 32ddb8127..65fcadc52 100644
@@ -323,8 +323,7 @@ action(const void *nodep, VISIT which, int depth)
 int
 main(void)
 {
-    int i, *ptr;
-    void *val;
+    int i, *ptr, **val;
 
     srand(time(NULL));
     for (i = 0; i < 12; i++) {
@@ -333,7 +332,7 @@ main(void)
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
-        else if ((*(int **) val) != ptr)
+        else if (*val != ptr)
             free(ptr);
     }
     twalk(root, action);
Signature · 1 line
2.28.0
#1 lore raw

Hi Alex,

Quoted 8 lines · Alejandro Colomar

The type of var is int **, and it will work with tsearch() anyway because of implicit cast from void *, so declaring it as an int ** simplifies the code.

---
 man3/tsearch.3 | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

By chance, I've just made a conflicting change, but also...

man3/tsearch.3 action(const void *nodep, VISIT which, int depth) · line 326

Quoted 11 lines
man3/tsearch.3 +1 -2
index 32ddb8127..65fcadc52 100644
@@ -323,8 +323,7 @@ action(const void *nodep, VISIT which, int depth)
 int
 main(void)
 {
-    int i, *ptr;
-    void *val;
+    int i, *ptr, **val;

Not quite your fault, since you followed an already poor example, but many people (and I am one of them) frown on declarations lines such as the above: 'int', 'int *' and 'int **' are three different types, and it's considered bad form to declare variables with different type in one source line. (It's very easy to overlook an asterisk or two when scanning the source.) Better is:

int i
int *ptr;
int **val;

man3/tsearch.3 main(void) · line 338

Quoted 12 lines
man3/tsearch.3 +1 -1
     srand(time(NULL));
     for (i = 0; i < 12; i++) {
@@ -333,7 +332,7 @@ main(void)
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
-        else if ((*(int **) val) != ptr)
+        else if (*val != ptr)
             free(ptr);
     }
     twalk(root, action);

Could you please recraft this patch against current Git, which changed in the last minutes...

Thanks,

Michael

Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#2 lore raw

Hi Michael,

Quoted 1 line · Michael Kerrisk (man-pages)

By chance, I've just made a conflicting change, but also...

I noticed while rebasing, and was already preparing the fix :)

Quoted 11 lines

man3/tsearch.3 action(const void *nodep, VISIT which, int depth) · line 326

Quoted 3 lines
man3/tsearch.3 +1 -2
-    int i, *ptr;
-    void *val;
+    int i, *ptr, **val;

Not quite your fault, since you followed an already poor example, but many people (and I am one of them) frown on declarations lines such as the above: 'int', 'int *' and 'int **' are three different types, and it's considered bad form to declare variables with different type in one source line. (It's very easy to overlook an asterisk or two when scanning the source.) Better is:

Quoted 3 lines

int i
int *ptr;
int **val;

Agree. I also do that in my code, but was following the existing practice.

Quoted 2 lines

Could you please recraft this patch against current Git, which changed in the last minutes...

Sure.

Regards,
Alex.

#3 lore raw

PATCH v2 1/1 tsearch.3: Simplify type usage and remove unneeded casts

The type of val is int **, and it will work with tsearch() anyway because of implicit cast from void *, so declaring it as an int ** simplifies the code.

---
 man3/tsearch.3 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man3/tsearch.3 +2 -2
index 2e8403130..7b82d9bd3 100644
@@ -323,7 +323,7 @@ action(const void *nodep, VISIT which, int depth)
 int
 main(void)
 {
-    void *val;
+    int **val;
 
     srand(time(NULL));
     for (int i = 0; i < 12; i++) {
@@ -332,7 +332,7 @@ main(void)
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
-        else if ((*(int **) val) != ptr)
+        else if (*val != ptr)
             free(ptr);
     }
     twalk(root, action);
Signature · 1 line
2.28.0
#4 lore raw

Hello Alex,

Quoted 3 lines · Alejandro Colomar

The type of val is int **, and it will work with tsearch() anyway because of implicit cast from void *, so declaring it as an int ** simplifies the code.

Thanks, patch applied.

Cheers,

Michael

Quoted 28 lines
---
 man3/tsearch.3 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man3/tsearch.3 +2 -2
index 2e8403130..7b82d9bd3 100644
@@ -323,7 +323,7 @@ action(const void *nodep, VISIT which, int depth)
 int
 main(void)
 {
-    void *val;
+    int **val;
 
     srand(time(NULL));
     for (int i = 0; i < 12; i++) {
@@ -332,7 +332,7 @@ main(void)
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
-        else if ((*(int **) val) != ptr)
+        else if (*val != ptr)
             free(ptr);
     }
     twalk(root, action);
Signature · 3 lines
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
#5 lore raw

Hello,
i am sorry to interrupt here but ...
IMHO the void *val is here for a reason, because it means "this can be anything" the reason why int ** works here is that the example uses int. You make the example to specific in this case. may be the example from bsearch is better here.

________________________________________

Von: [email protected] [[email protected]] im Auftrag von Michael Kerrisk (man-pages) [[email protected]]
Gesendet: Samstag, 5. September 2020 21:42
An: Alejandro Colomar
Cc: [email protected]; [email protected]
Betreff: Re: [PATCH v2] tsearch.3: Simplify type usage and remove unneeded casts

Hello Alex,

Quoted 3 lines · Alejandro Colomar

The type of val is int **, and it will work with tsearch() anyway because of implicit cast from void *, so declaring it as an int ** simplifies the code.

Thanks, patch applied.

Cheers,

Michael

Quoted 20 lines
---
 man3/tsearch.3 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
man3/tsearch.3 +1 -1
index 2e8403130..7b82d9bd3 100644
@@ -323,7 +323,7 @@ action(const void *nodep, VISIT which, int depth)
 int
 main(void)
 {
-    void *val;
+    int **val;
 
     srand(time(NULL));
     for (int i = 0; i < 12; i++) {

man3/tsearch.3 main(void) · line 338

Quoted 8 lines
man3/tsearch.3 +1 -1
@@ -332,7 +332,7 @@ main(void)
         val = tsearch((void *) ptr, &root, compare);
         if (val == NULL)
             exit(EXIT_FAILURE);
-        else if ((*(int **) val) != ptr)
+        else if (*val != ptr)
             free(ptr);
     }
     twalk(root, action);

--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

#6 lore raw

Hello Walter,

Quoted 6 lines · Walter Harms

Hello,
i am sorry to interrupt here but ...
IMHO the void *val is here for a reason, because it means "this can be anything" the reason why int ** works here is that the example uses int. You make the example to specific in this case. may be the example from bsearch is better here.

I would say the example isn't clearer with void * and the cast; I see it OK as it is now. But let's see what others think about it...

Cheers,

Alex.