treewide: rename chip property accessors
authorBartosz Golaszewski <brgl@bgdev.pl>
Fri, 2 Apr 2021 13:51:47 +0000 (15:51 +0200)
committerBartosz Golaszewski <brgl@bgdev.pl>
Sat, 17 Apr 2021 11:36:02 +0000 (13:36 +0200)
In v2 API all getters will be called using the following pattern:

    gpiod_<object>_get_<what>

Apply this to already existing getters for gpiod_chip.

Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
bindings/cxx/chip.cpp
bindings/python/gpiodmodule.c
include/gpiod.h
lib/core.c
lib/helpers.c
tests/tests-chip.c
tools/gpiodetect.c
tools/gpiofind.c
tools/gpioinfo.c

index d5a983780feb435b01b369d39ec8bf434b80665b..ee6ab6f8776407ee1825e8f2c68787ac83232af8 100644 (file)
@@ -62,21 +62,21 @@ GPIOD_CXX_API ::std::string chip::name(void) const
 {
        this->throw_if_noref();
 
-       return ::std::string(::gpiod_chip_name(this->_m_chip.get()));
+       return ::std::string(::gpiod_chip_get_name(this->_m_chip.get()));
 }
 
 GPIOD_CXX_API ::std::string chip::label(void) const
 {
        this->throw_if_noref();
 
-       return ::std::string(::gpiod_chip_label(this->_m_chip.get()));
+       return ::std::string(::gpiod_chip_get_label(this->_m_chip.get()));
 }
 
 GPIOD_CXX_API unsigned int chip::num_lines(void) const
 {
        this->throw_if_noref();
 
-       return ::gpiod_chip_num_lines(this->_m_chip.get());
+       return ::gpiod_chip_get_num_lines(this->_m_chip.get());
 }
 
 GPIOD_CXX_API line chip::get_line(unsigned int offset) const
index 8bfb4c4f7662bb4dae1cfc88202b70aa7ebec8ec..ed039e468f03f8d5719d7b45478a305905ada837 100644 (file)
@@ -1918,9 +1918,9 @@ static PyObject *gpiod_Chip_repr(gpiod_ChipObject *self)
                return NULL;
 
        return PyUnicode_FromFormat("'%s /%s/ %u lines'",
-                                   gpiod_chip_name(self->chip),
-                                   gpiod_chip_label(self->chip),
-                                   gpiod_chip_num_lines(self->chip));
+                                   gpiod_chip_get_name(self->chip),
+                                   gpiod_chip_get_label(self->chip),
+                                   gpiod_chip_get_num_lines(self->chip));
 }
 
 PyDoc_STRVAR(gpiod_Chip_close_doc,
@@ -1971,7 +1971,7 @@ static PyObject *gpiod_Chip_name(gpiod_ChipObject *self,
        if (gpiod_ChipIsClosed(self))
                return NULL;
 
-       return PyUnicode_FromFormat("%s", gpiod_chip_name(self->chip));
+       return PyUnicode_FromFormat("%s", gpiod_chip_get_name(self->chip));
 }
 
 PyDoc_STRVAR(gpiod_Chip_label_doc,
@@ -1985,7 +1985,7 @@ static PyObject *gpiod_Chip_label(gpiod_ChipObject *self,
        if (gpiod_ChipIsClosed(self))
                return NULL;
 
-       return PyUnicode_FromFormat("%s", gpiod_chip_label(self->chip));
+       return PyUnicode_FromFormat("%s", gpiod_chip_get_label(self->chip));
 }
 
 PyDoc_STRVAR(gpiod_Chip_num_lines_doc,
@@ -1999,7 +1999,7 @@ static PyObject *gpiod_Chip_num_lines(gpiod_ChipObject *self,
        if (gpiod_ChipIsClosed(self))
                return NULL;
 
-       return Py_BuildValue("I", gpiod_chip_num_lines(self->chip));
+       return Py_BuildValue("I", gpiod_chip_get_num_lines(self->chip));
 }
 
 static gpiod_LineObject *
@@ -2381,7 +2381,7 @@ static gpiod_LineObject *gpiod_LineIter_next(gpiod_LineIterObject *self)
 {
        struct gpiod_line *line;
 
-       if (self->offset == gpiod_chip_num_lines(self->owner->chip))
+       if (self->offset == gpiod_chip_get_num_lines(self->owner->chip))
                return NULL; /* Last element. */
 
        line = gpiod_chip_get_line(self->owner->chip, self->offset++);
index 5aea01f3e395bc8254854ae034a8b44c2c85bce3..a4ce01f126fb5e95f1ca0dfd7c910644747eeba9 100644 (file)
@@ -94,21 +94,21 @@ void gpiod_chip_unref(struct gpiod_chip *chip);
  * @param chip The GPIO chip object.
  * @return Pointer to a human-readable string containing the chip name.
  */
-const char *gpiod_chip_name(struct gpiod_chip *chip);
+const char *gpiod_chip_get_name(struct gpiod_chip *chip);
 
 /**
  * @brief Get the GPIO chip label as represented in the kernel.
  * @param chip The GPIO chip object.
  * @return Pointer to a human-readable string containing the chip label.
  */
-const char *gpiod_chip_label(struct gpiod_chip *chip);
+const char *gpiod_chip_get_label(struct gpiod_chip *chip);
 
 /**
  * @brief Get the number of GPIO lines exposed by this chip.
  * @param chip The GPIO chip object.
  * @return Number of GPIO lines.
  */
-unsigned int gpiod_chip_num_lines(struct gpiod_chip *chip);
+unsigned int gpiod_chip_get_num_lines(struct gpiod_chip *chip);
 
 /**
  * @brief Get the handle to the GPIO line at given offset.
index 32c4238a500b27c86520f712bfc38cc5a41b20e2..2e7ee4b5b8968e2ad9ab9cd2e675afc2b60c42c5 100644 (file)
@@ -335,17 +335,17 @@ GPIOD_API void gpiod_chip_unref(struct gpiod_chip *chip)
        free(chip);
 }
 
-GPIOD_API const char *gpiod_chip_name(struct gpiod_chip *chip)
+GPIOD_API const char *gpiod_chip_get_name(struct gpiod_chip *chip)
 {
        return chip->name;
 }
 
-GPIOD_API const char *gpiod_chip_label(struct gpiod_chip *chip)
+GPIOD_API const char *gpiod_chip_get_label(struct gpiod_chip *chip)
 {
        return chip->label;
 }
 
-GPIOD_API unsigned int gpiod_chip_num_lines(struct gpiod_chip *chip)
+GPIOD_API unsigned int gpiod_chip_get_num_lines(struct gpiod_chip *chip)
 {
        return chip->num_lines;
 }
index 9c4b28e5fa0fcb79143793cc6a93bc6b00f5ad7f..fb53518b053ddd275e7dbd7a2f7f25b1bcf77469 100644 (file)
@@ -45,11 +45,11 @@ gpiod_chip_get_all_lines(struct gpiod_chip *chip)
        struct gpiod_line *line;
        unsigned int offset;
 
-       bulk = gpiod_line_bulk_new(gpiod_chip_num_lines(chip));
+       bulk = gpiod_line_bulk_new(gpiod_chip_get_num_lines(chip));
        if (!bulk)
                return NULL;
 
-       for (offset = 0; offset < gpiod_chip_num_lines(chip); offset++) {
+       for (offset = 0; offset < gpiod_chip_get_num_lines(chip); offset++) {
                line = gpiod_chip_get_line(chip, offset);
                if (!line) {
                        gpiod_line_bulk_free(bulk);
@@ -68,7 +68,7 @@ GPIOD_API int gpiod_chip_find_line(struct gpiod_chip *chip, const char *name)
        struct gpiod_line *line;
        const char *tmp;
 
-       num_lines = gpiod_chip_num_lines(chip);
+       num_lines = gpiod_chip_get_num_lines(chip);
 
        for (offset = 0; offset < num_lines; offset++) {
                line = gpiod_chip_get_line(chip, offset);
index a87dc9a4b7acb9a310bd618e91d2339223b9eeb3..46fb8d20a0a9ad708c7f8d10c699812186af3fa0 100644 (file)
@@ -63,9 +63,12 @@ GPIOD_TEST_CASE(get_name, 0, { 8, 8, 8})
        g_assert_nonnull(chip2);
        gpiod_test_return_if_failed();
 
-       g_assert_cmpstr(gpiod_chip_name(chip0), ==, gpiod_test_chip_name(0));
-       g_assert_cmpstr(gpiod_chip_name(chip1), ==, gpiod_test_chip_name(1));
-       g_assert_cmpstr(gpiod_chip_name(chip2), ==, gpiod_test_chip_name(2));
+       g_assert_cmpstr(gpiod_chip_get_name(chip0), ==,
+                       gpiod_test_chip_name(0));
+       g_assert_cmpstr(gpiod_chip_get_name(chip1), ==,
+                       gpiod_test_chip_name(1));
+       g_assert_cmpstr(gpiod_chip_get_name(chip2), ==,
+                       gpiod_test_chip_name(2));
 }
 
 GPIOD_TEST_CASE(get_label, 0, { 8, 8, 8})
@@ -83,9 +86,9 @@ GPIOD_TEST_CASE(get_label, 0, { 8, 8, 8})
        g_assert_nonnull(chip2);
        gpiod_test_return_if_failed();
 
-       g_assert_cmpstr(gpiod_chip_label(chip0), ==, "gpio-mockup-A");
-       g_assert_cmpstr(gpiod_chip_label(chip1), ==, "gpio-mockup-B");
-       g_assert_cmpstr(gpiod_chip_label(chip2), ==, "gpio-mockup-C");
+       g_assert_cmpstr(gpiod_chip_get_label(chip0), ==, "gpio-mockup-A");
+       g_assert_cmpstr(gpiod_chip_get_label(chip1), ==, "gpio-mockup-B");
+       g_assert_cmpstr(gpiod_chip_get_label(chip2), ==, "gpio-mockup-C");
 }
 
 GPIOD_TEST_CASE(num_lines, 0, { 1, 4, 8, 16, 32 })
@@ -109,11 +112,11 @@ GPIOD_TEST_CASE(num_lines, 0, { 1, 4, 8, 16, 32 })
        g_assert_nonnull(chip4);
        gpiod_test_return_if_failed();
 
-       g_assert_cmpuint(gpiod_chip_num_lines(chip0), ==, 1);
-       g_assert_cmpuint(gpiod_chip_num_lines(chip1), ==, 4);
-       g_assert_cmpuint(gpiod_chip_num_lines(chip2), ==, 8);
-       g_assert_cmpuint(gpiod_chip_num_lines(chip3), ==, 16);
-       g_assert_cmpuint(gpiod_chip_num_lines(chip4), ==, 32);
+       g_assert_cmpuint(gpiod_chip_get_num_lines(chip0), ==, 1);
+       g_assert_cmpuint(gpiod_chip_get_num_lines(chip1), ==, 4);
+       g_assert_cmpuint(gpiod_chip_get_num_lines(chip2), ==, 8);
+       g_assert_cmpuint(gpiod_chip_get_num_lines(chip3), ==, 16);
+       g_assert_cmpuint(gpiod_chip_get_num_lines(chip4), ==, 32);
 }
 
 GPIOD_TEST_CASE(get_line, 0, { 16 })
index 9f4c28c65b3478c11a502416c816adc3d1df0022..10706e23dcfc3f398ceccad2974cc436d8d3f694 100644 (file)
@@ -76,9 +76,9 @@ int main(int argc, char **argv)
                }
 
                printf("%s [%s] (%u lines)\n",
-                      gpiod_chip_name(chip),
-                      gpiod_chip_label(chip),
-                      gpiod_chip_num_lines(chip));
+                      gpiod_chip_get_name(chip),
+                      gpiod_chip_get_label(chip),
+                      gpiod_chip_get_num_lines(chip));
 
                gpiod_chip_unref(chip);
                free(entries[i]);
index 83af76bbb6b3e1600b94f39eb825df384a5f9791..32b78529c8c204adbda9cb117437485da5ed5d50 100644 (file)
@@ -76,7 +76,7 @@ int main(int argc, char **argv)
                offset = gpiod_chip_find_line(chip, argv[0]);
                if (offset >= 0) {
                        printf("%s %u\n",
-                              gpiod_chip_name(chip), offset);
+                              gpiod_chip_get_name(chip), offset);
                        gpiod_chip_unref(chip);
                        return EXIT_SUCCESS;
                }
index eba8c72e4be47f18d97a22e382fd84e8ae36cc87..3d8911176281e19de773ca09ac70d6dabc447544 100644 (file)
@@ -130,9 +130,9 @@ static void list_lines(struct gpiod_chip *chip)
        int direction;
 
        printf("%s - %u lines:\n",
-              gpiod_chip_name(chip), gpiod_chip_num_lines(chip));
+              gpiod_chip_get_name(chip), gpiod_chip_get_num_lines(chip));
 
-       for (offset = 0; offset < gpiod_chip_num_lines(chip); offset++) {
+       for (offset = 0; offset < gpiod_chip_get_num_lines(chip); offset++) {
                line = gpiod_chip_get_line(chip, offset);
                if (!line)
                        die_perror("unable to retrieve the line object from chip");