[GRASS-dev] [GRASS GIS] #2422: Functions from Segment lib have no prefix

GDAL · September 16, 2014, 3:53pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------
In contrast to other GRASS libs, Segment lib (1) doesn't use any prefix. I
would suggest to change eg.

{{{
segment_open()
}}}

to

{{{
Rast_segment_open()
}}}

Any option? Marked as blocker since it's API change.

(1) http://grass.osgeo.org/programming7/segmentlib.html

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422>
GRASS GIS <http://grass.osgeo.org>

GDAL · September 16, 2014, 3:56pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by martinl):

Replying to [ticket:2422 martinl]:
> {{{
> Rast_segment_open()
> }}}

Or

{{{
Segment_segment_open()
}}}

inspired by Row Input/Output Library,
http://grass.osgeo.org/programming7/rowiolib.html

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:1>
GRASS GIS <http://grass.osgeo.org>

GDAL · September 16, 2014, 3:57pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by martinl):

Replying to [comment:1 martinl]:

> {{{
> Segment_segment_open()
> }}}
>
> inspired by Row Input/Output Library,
http://grass.osgeo.org/programming7/rowiolib.html

I meant

{{{
Segment_open()
}}}

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:2>
GRASS GIS <http://grass.osgeo.org>

GDAL · September 16, 2014, 4:00pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by martinl):

Replying to [comment:2 martinl]:
> Replying to [comment:1 martinl]:

> > inspired by Row Input/Output Library,
http://grass.osgeo.org/programming7/rowiolib.html

from this point of view, we could rename function in this library to eg.

{{{
Rowio_get() -> Rast_rowio_get()
}}}

and

{{{
segment_open() -> Rast_segment_open()
}}}

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:3>
GRASS GIS <http://grass.osgeo.org>

GDAL · September 16, 2014, 7:44pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by mmetz):

Replying to [ticket:2422 martinl]:
> In contrast to other GRASS libs, Segment lib (1) doesn't use any prefix.

The prefix used by the segment lib is "segment_".

> I would suggest to change eg.
{{{
segment_open()
}}}
>
> to
Replying to [comment:2 martinl]:
>
{{{
Segment_open()
}}}
>

So you mean to change the first letter of the prefix to upper case?

E.g. "Rast_segment_open" does not make sense to me because the segment
library is standalone and not part of the raster library.

Currently library functions for each library have their own prefix (that
happened also when splitting gis lib in gis lib and raster lib). This
convention makes work for developers easier and I would suggest to keep
it. Thus e.g. "Rowio_get()" is just fine, no need to mask it as a raster
lib function, it is a rowio lib function.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:4>
GRASS GIS <http://grass.osgeo.org>

GDAL · October 7, 2014, 5:37pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by martinl):

Replying to [comment:4 mmetz]:
{{{
> Segment_open()
}}}
> >
>
> So you mean to change the first letter of the prefix to upper case?

yes, it's consistent with prefixes from other GRASS libs which are upper-
case. If no objection I will do this change within the next days.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:5>
GRASS GIS <http://grass.osgeo.org>

GDAL · October 21, 2014, 3:48pm

#2422: Functions from Segment lib have no prefix
-------------------------------------+--------------------------------------
Reporter: martinl | Owner: grass-dev@…
Type: task | Status: new
Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Keywords: segmentlib, api, prefix | Platform: Unspecified
Cpu: Unspecified |
-------------------------------------+--------------------------------------

Comment(by neteler):

I have updated trunk accordingly in r62324.

TODO: backport if all is ok and update Addons.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/2422#comment:6>
GRASS GIS <http://grass.osgeo.org>

GDAL · October 22, 2014, 7:49am

#2422: Functions from Segment lib have no prefix
--------------------------+-------------------------------------------------
  Reporter: martinl | Owner: grass-dev@…
      Type: task | Status: closed
  Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Resolution: fixed | Keywords: segmentlib, api, prefix
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------
Changes (by neteler):

* status: new => closed
* resolution: => fixed

Comment:

Replying to [comment:6 neteler]:
> TODO: backport if all is ok and update Addons.

Done in r62336 (relbr7) and r62337 (G7 Addons). Closing.

--
Ticket URL: <http://trac.osgeo.org/grass/ticket/2422#comment:7>
GRASS GIS <http://grass.osgeo.org>

GDAL · October 24, 2014, 11:15am

#2422: Functions from Segment lib have no prefix
--------------------------+-------------------------------------------------
  Reporter: martinl | Owner: grass-dev@…
      Type: task | Status: closed
  Priority: blocker | Milestone: 7.0.0
Component: LibRaster | Version: unspecified
Resolution: fixed | Keywords: segmentlib, api, prefix
  Platform: Unspecified | Cpu: Unspecified
--------------------------+-------------------------------------------------

Comment(by neteler):

For the record: r62372 and r62373 (separate internal and external
functions)

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/2422#comment:8>
GRASS GIS <http://grass.osgeo.org>