Merge pull request #2774 from heeplr/hal_export_functf

introduce hal_export_functf()

Author: andypugh

docs/man/man3/hal_export_functf.3hal

@@ -0,0 +1 @@
+.so man3/hal_export_funct.3hal

docs/po4a.cfg

@@ -264,6 +264,7 @@
 [type: man_def] man/man3/hal_del_funct_from_thread.3hal $lang:man/$lang/man3/hal_del_funct_from_thread.3hal
 [type: man_def] man/man3/hal_exit.3hal $lang:man/$lang/man3/hal_exit.3hal
 [type: man_def] man/man3/hal_export_funct.3hal $lang:man/$lang/man3/hal_export_funct.3hal
+[type: man_def] man/man3/hal_export_functf.3hal $lang:man/$lang/man3/hal_export_functf.3hal
 [type: man_def] man/man3/hal_float_t.3hal $lang:man/$lang/man3/hal_float_t.3hal
 [type: man_def] man/man3/hal_get_lock.3hal $lang:man/$lang/man3/hal_get_lock.3hal
 [type: man_def] man/man3/hal_init.3hal $lang:man/$lang/man3/hal_init.3hal

docs/src/hal/components.adoc

@@ -339,6 +339,7 @@ hal_create_thread.3hal
 hal_del_funct_from_thread.3hal
 hal_exit.3hal
 hal_export_funct.3hal
+hal_export_functf.3hal
 hal_float_t.3hal
 hal_get_lock.3hal
 hal_init.3hal

src/hal/components/boss_plc.c

@@ -201,7 +201,7 @@ typedef struct {
     hal_bit_t                   limitNeg;
 } Limit;
 
-static int Limit_Export(Limit *this, int compId, int id, char *name, char axis);
+static int Limit_Export(Limit *this, int compId, int id, char axis);
 static void Limit_Init(Limit *this);
 static BOOL Limit_IsActive(Limit *this);
 static void Limit_Refresh(Limit *this, hal_bit_t override);
@@ -225,7 +225,7 @@ typedef struct {
     hal_bit_t                   lastEnable;
 } Amp;
 
-static int Amp_Export(Amp *this, int compId, int id, char *name, char axis);
+static int Amp_Export(Amp *this, int compId, int id, char axis);
 static void Amp_Init(Amp *this);
 static void Amp_Refresh(Amp *this, long period, hal_u32_t readyDelay);
 
@@ -313,11 +313,11 @@ typedef struct {
 // These methods are used for initialization.
 static int Plc_Init(Plc *this);
 static int Plc_Export(Plc *this, int compId, int id);
-static int Plc_ExportFeed(Plc *this, int compId, int id, char *name);
-static int Plc_ExportLimits(Plc *this, int compId, int id, char *name);
-static int Plc_ExportAmps(Plc *this, int compId, int id, char *name);
-static int Plc_ExportSpindle(Plc *this, int compId, int id, char *name);
-static int Plc_ExportJog(Plc *this, int compId, int id, char *name);
+static int Plc_ExportFeed(Plc *this, int compId, int id);
+static int Plc_ExportLimits(Plc *this, int compId, int id);
+static int Plc_ExportAmps(Plc *this, int compId, int id);
+static int Plc_ExportSpindle(Plc *this, int compId, int id);
+static int Plc_ExportJog(Plc *this, int compId, int id);
 
 // These methods are exported to the HAL.
 static void Plc_Refresh(void *this, long period);
@@ -468,7 +468,6 @@ static int
 Plc_Export(Plc *this, int compId, int id)
 {
     int                         msgLevel, error;
-    char                        name[HAL_NAME_LEN + 1];
 
     // This function exports a lot of stuff, which results in a lot of
     // logging if msg_level is at INFO or ALL. So we save the current value
@@ -478,27 +477,26 @@ Plc_Export(Plc *this, int compId, int id)
     rtapi_set_msg_level(RTAPI_MSG_WARN);
 
     // Export pins and parameters.
-    error = Plc_ExportFeed(this, compId, id, name);
+    error = Plc_ExportFeed(this, compId, id);
 
     if(!error){
-        error = Plc_ExportLimits(this, compId, id, name);
+        error = Plc_ExportLimits(this, compId, id);
     }
 
     if(!error){
-        error = Plc_ExportAmps(this, compId, id, name);
+        error = Plc_ExportAmps(this, compId, id);
     }
 
     if(!error){
-        error = Plc_ExportSpindle(this, compId, id, name);
+        error = Plc_ExportSpindle(this, compId, id);
     }
     if(!error){
-        error = Plc_ExportJog(this, compId, id, name);
+        error = Plc_ExportJog(this, compId, id);
     }
 
     // Export functions.
     if(!error){
-        rtapi_snprintf(name, sizeof(name), "boss_plc.%d.refresh", id);
-        error = hal_export_funct(name, Plc_Refresh, this, 1, 0, compId);
+        error = hal_export_functf(Plc_Refresh, this, 1, 0, compId, "boss_plc.%d.refresh", id);
     }
 
     // Restore saved message level.
@@ -509,7 +507,7 @@ Plc_Export(Plc *this, int compId, int id)
 
 
 static int
-Plc_ExportFeed(Plc *this, int compId, int id, char *name)
+Plc_ExportFeed(Plc *this, int compId, int id)
 {
     int                         error;
 
@@ -578,7 +576,7 @@ Plc_ExportFeed(Plc *this, int compId, int id, char *name)
 
 
 static int
-Plc_ExportLimits(Plc *this, int compId, int id, char *name)
+Plc_ExportLimits(Plc *this, int compId, int id)
 {
     int                         error;
 
@@ -592,11 +590,11 @@ Plc_ExportLimits(Plc *this, int compId, int id, char *name)
     }
 
     if(!error){
-        error = Limit_Export(&this->xLimit, compId, id, name, axisNames[0]);
+        error = Limit_Export(&this->xLimit, compId, id, axisNames[0]);
     }
 
     if(!error){
-        error = Limit_Export(&this->yLimit, compId, id, name, axisNames[1]);
+        error = Limit_Export(&this->yLimit, compId, id, axisNames[1]);
     }
 
     if(!error){
@@ -642,7 +640,7 @@ Plc_ExportLimits(Plc *this, int compId, int id, char *name)
 
 
 static int
-Plc_ExportAmps(Plc *this, int compId, int id, char *name)
+Plc_ExportAmps(Plc *this, int compId, int id)
 {
     int                         error, i;
     Amp                         *pAmp;
@@ -652,15 +650,15 @@ Plc_ExportAmps(Plc *this, int compId, int id, char *name)
 
     pAmp = this->amps;
     for(i = 0; i < NUM_AXIS && !error; i++, pAmp++){
-        error = Amp_Export(pAmp, compId, id, name, axisNames[i]);
+        error = Amp_Export(pAmp, compId, id, axisNames[i]);
     }
 
     return(error);
 }
 
 
 static int
-Plc_ExportSpindle(Plc *this, int compId, int id, char *name)
+Plc_ExportSpindle(Plc *this, int compId, int id)
 {
     int                         error;
 
@@ -742,7 +740,7 @@ Plc_ExportSpindle(Plc *this, int compId, int id, char *name)
 
 
 static int
-Plc_ExportJog(Plc *this, int compId, int id, char *name)
+Plc_ExportJog(Plc *this, int compId, int id)
 {
     int                         error, i;
 
@@ -969,7 +967,7 @@ Plc_RefreshJog(Plc *this, long period)
  ******************************************************************************/
 
 static int
-Limit_Export(Limit *this, int compId, int id, char *name, char axis)
+Limit_Export(Limit *this, int compId, int id, char axis)
 {
     int                         error;
 
@@ -1084,7 +1082,7 @@ Limit_Refresh(Limit *this, hal_bit_t override)
  ******************************************************************************/
 
 static int
-Amp_Export(Amp *this, int compId, int id, char *name, char axis)
+Amp_Export(Amp *this, int compId, int id, char axis)
 {
     int                         error;
 

src/hal/components/debounce.c

@@ -229,7 +229,6 @@ static void debounce(void *arg, long period)
 static int export_group(int num, debounce_group_t * addr, int group_size)
 {
     int n, retval, msg;
-    char buf[HAL_NAME_LEN + 1];
 
     /* This function exports a lot of stuff, which results in a lot of
        logging if msg_level is at INFO or ALL. So we save the current value
@@ -246,19 +245,17 @@ static int export_group(int num, debounce_group_t * addr, int group_size)
 	return -1;
     }
     /* export param variable for delay */
-    rtapi_snprintf(buf, sizeof(buf), "debounce.%d.delay", num);
-    retval = hal_param_s32_new(buf, HAL_RW, &(addr->delay), comp_id);
+    retval = hal_param_s32_newf(HAL_RW, &(addr->delay), comp_id, "debounce.%d.delay", num);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
-	    "DEBOUNCE: ERROR: '%s' param export failed\n", buf);
+	    "DEBOUNCE: ERROR: 'debounce.%d.delay' param export failed\n", num);
 	return retval;
     }
     /* export function */
-    rtapi_snprintf(buf, sizeof(buf), "debounce.%d", num);
-    retval = hal_export_funct(buf, debounce, addr, 0, 0, comp_id);
+    retval = hal_export_functf(debounce, addr, 0, 0, comp_id, "debounce.%d", num);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
-	    "DEBOUNCE: ERROR: '%s' funct export failed\n", buf);
+	    "DEBOUNCE: ERROR: 'debounce.%d' funct export failed\n", num);
 	return -1;
     }
     /* set default parameter values */

src/hal/components/mux_generic.c

@@ -168,12 +168,8 @@ int rtapi_app_main(void){
             inst->out_type = inst->in_type;
         }
 
-        retval = rtapi_snprintf(hal_name, HAL_NAME_LEN, "mux-gen.%02i", i);
-        if (retval >= HAL_NAME_LEN) {
-            goto fail0;
-        }
         if (inst->in_type == HAL_FLOAT || inst->out_type == HAL_FLOAT) {
-            retval = hal_export_funct(hal_name, write_fp, inst, 1, 0, comp_id);
+            retval = hal_export_functf(write_fp, inst, 1, 0, comp_id, "mux-gen.%02i", i);
             if (retval < 0) {
                 rtapi_print_msg(RTAPI_MSG_ERR, "mux_generic: ERROR: function export"
                         " failed\n");
@@ -182,7 +178,7 @@ int rtapi_app_main(void){
         }
         else
         {
-            retval = hal_export_funct(hal_name, write_nofp, inst, 0, 0, comp_id);
+            retval = hal_export_functf(write_nofp, inst, 0, 0, comp_id, "mux-gen.%02i", i);
             if (retval < 0) {
                 rtapi_print_msg(RTAPI_MSG_ERR, "mux_generic: ERROR: function export"
                         " failed\n");

src/hal/components/pid.c

@@ -689,7 +689,6 @@ static void calc_pid(void *arg, long period)
 static int export_pid(hal_pid_t * addr, char * prefix)
 {
     int retval, msg;
-    char buf[HAL_NAME_LEN + 1];
 
     /* This function exports a lot of stuff, which results in a lot of
        logging if msg_level is at INFO or ALL. So we save the current value
@@ -963,9 +962,8 @@ static int export_pid(hal_pid_t * addr, char * prefix)
     *(addr->pTuneStart) = 0;
 #endif /* AUTO_TUNER */
     /* export function for this loop */
-    rtapi_snprintf(buf, sizeof(buf), "%s.do-pid-calcs", prefix);
     retval =
-	hal_export_funct(buf, calc_pid, addr, 1, 0, comp_id);
+	hal_export_functf(calc_pid, addr, 1, 0, comp_id, "%s.do-pid-calcs", prefix);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
 	    NAME ": ERROR: do_pid_calcs funct export failed\n");

src/hal/components/sampler.c

@@ -289,8 +289,7 @@ static int init_sampler(int num, sampler_t *str)
 	pptr++;
     }
     /* export update function */
-    rtapi_snprintf(buf, sizeof(buf), "sampler.%d", num);
-    retval = hal_export_funct(buf, sample, str, usefp, 0, comp_id);
+    retval = hal_export_functf(sample, str, usefp, 0, comp_id, "sampler.%d", num);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
 	    "SAMPLER: ERROR: function export failed\n");

src/hal/components/siggen.c

@@ -277,7 +277,6 @@ static void calc_siggen(void *arg, long period)
 static int export_siggen(int num, hal_siggen_t * addr,char* prefix)
 {
     int retval;
-    char buf[HAL_NAME_LEN + 1];
 
     /* export pins */
     retval = hal_pin_float_newf(HAL_OUT, &(addr->square), comp_id,
@@ -342,10 +341,9 @@ static int export_siggen(int num, hal_siggen_t * addr,char* prefix)
     *(addr->offset) = 0.0;
     addr->index = 0.0;
     /* export function for this loop */
-    rtapi_snprintf(buf, sizeof(buf), "%s.update", prefix);
     retval =
-	hal_export_funct(buf, calc_siggen, &(siggen_array[num]), 1, 0,
-	comp_id);
+	hal_export_functf(calc_siggen, &(siggen_array[num]), 1, 0,
+	comp_id, "%s.update", prefix);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
 	    "SIGGEN: ERROR: update funct export failed\n");

src/hal/components/streamer.c

@@ -346,8 +346,7 @@ static int init_streamer(int num, streamer_t *str)
 	pptr++;
     }
     /* export update function */
-    rtapi_snprintf(buf, sizeof(buf), "streamer.%d", num);
-    retval = hal_export_funct(buf, update, str, usefp, 0, comp_id);
+    retval = hal_export_functf(update, str, usefp, 0, comp_id, "streamer.%d", num);
     if (retval != 0) {
 	rtapi_print_msg(RTAPI_MSG_ERR,
 	    "STREAMER: ERROR: function export failed\n");