vim: src/if_cscope.c comparison

comparison src/if_cscope.c @ 10373:bd674706408a v8.0.0081

commit https://github.com/vim/vim/commit/d4db7719bdfbc54df396eac08d8cbb2389feacf4 Author: Bram Moolenaar <Bram@vim.org> Date: Sat Nov 12 19:16:46 2016 +0100 patch 8.0.0081 Problem: Inconsistent function names. Solution: Rename do_cscope to ex_cscope. Clean up comments.

author	Christian Brabandt <cb@256bit.org>
date	Sat, 12 Nov 2016 19:30:04 +0100
parents	66f1b5bf3fa6
children	9279c939391b

comparison

equal deleted inserted replaced

-:f99b48e4cb62
+:bd674706408a
 }
 #endif /* FEAT_CMDL_COMPL */
 /*
-* PRIVATE: do_cscope_general
-*
 * Find the command, print help if invalid, and then call the corresponding
 * command function.
 */
 static void
 do_cscope_general(
 postponed_split_tab = 0;
 #endif
 }
 /*
-* PUBLIC: do_cscope
+* Implementation of ":cscope" and ":lcscope"
 */
 void
-do_cscope(exarg_T *eap)
+ex_cscope(exarg_T *eap)
 {
 do_cscope_general(eap, FALSE);
 }
 /*
-* PUBLIC: do_scscope
+* Implementation of ":scscope". Same as ex_cscope(), but splits window, too.
-*
-* same as do_cscope, but splits window, too.
 */
 void
-do_scscope(exarg_T *eap)
+ex_scscope(exarg_T *eap)
 {
 do_cscope_general(eap, TRUE);
 }
 /*
-* PUBLIC: do_cstag
+* Implementation of ":cstag"
-*
 */
 void
-do_cstag(exarg_T *eap)
+ex_cstag(exarg_T *eap)
 {
 int ret = FALSE;
 if (*eap->arg == NUL)
 {
 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
 	g_do_tagpreview = 0;
 #endif
 }
-} /* do_cscope */
+}
 /*
-* PUBLIC: cs_find
+* This simulates a vim_fgets(), but for cscope, returns the next line
-*
-* this simulates a vim_fgets(), but for cscope, returns the next line
 * from the cscope output.  should only be called from find_tags()
 *
 * returns TRUE if eof, FALSE otherwise
 */
 int
 return FALSE;
 } /* cs_fgets */
 /*
-* PUBLIC: cs_free_tags
+* Called only from do_tag(), when popping the tag stack.
-*
-* called only from do_tag(), when popping the tag stack
 */
 void
 cs_free_tags(void)
 {
 cs_manage_matches(NULL, NULL, -1, Free);
 }
 /*
-* PUBLIC: cs_print_tags
+* Called from do_tag().
-*
-* called from do_tag()
 */
 void
 cs_print_tags(void)
 {
 cs_manage_matches(NULL, NULL, -1, Print);
 /*
 * PRIVATE functions
 ****************************************************************************/
 /*
-* PRIVATE: cs_add
+* Add cscope database or a directory name (to look for cscope.out)
-*
+* to the cscope connection list.
-* add cscope database or a directory name (to look for cscope.out)
-* to the cscope connection list
-*
-* MAXPATHL 256
 */
 static int
 cs_add(exarg_T *eap UNUSED)
 {
 char *fname, *ppath, *flags = NULL;
 	(void)EMSG(_("E563: stat error"));
 }
 /*
-* PRIVATE: cs_add_common
+* The common routine to add a new cscope connection.  Called by
-*
+* cs_add() and cs_reset().  I really don't like to do this, but this
-* the common routine to add a new cscope connection.  called by
-* cs_add() and cs_reset().  i really don't like to do this, but this
 * routine uses a number of goto statements.
 */
 static int
 cs_add_common(
 char *arg1,	    /* filename - may contain environment variables */
 return (p_tags[0] != NUL && curbuf->b_p_tags != NULL);
 } /* cs_check_for_tags */
 /*
-* PRIVATE: cs_cnt_connections
+* Count the number of cscope connections.
-*
-* count the number of cscope connections
 */
 static int
 cs_cnt_connections(void)
 {
 short i;
 EMSGN(_("E262: error reading cscope connection %ld"), idx);
 }
 #define	CSREAD_BUFSIZE	2048
 /*
-* PRIVATE: cs_cnt_matches
+* Count the number of matches for a given cscope connection.
-*
-* count the number of matches for a given cscope connection.
 */
 static int
 cs_cnt_matches(int idx)
 {
 char *stok;
 return nlines;
 } /* cs_cnt_matches */
 /*
-* PRIVATE: cs_create_cmd
-*
 * Creates the actual cscope command query from what the user entered.
 */
 static char *
 cs_create_cmd(char *csoption, char *pattern)
 {
 return cmd;
 } /* cs_create_cmd */
 /*
-* PRIVATE: cs_create_connection
-*
 * This piece of code was taken/adapted from nvi.  do we need to add
 * the BSD license notice?
 */
 static int
 cs_create_connection(int i)
 return CSCOPE_SUCCESS;
 } /* cs_create_connection */
 /*
-* PRIVATE: cs_find
-*
 * Query cscope using command line interface.  Parse the output and use tselect
 * to allow choices.  Like Nvi, creates a pipe to send to/from query/cscope.
 *
 * returns TRUE if we jump to a tag or abort, FALSE if not.
 */
 				  eap->cmdidx == CMD_lcscope, *eap->cmdlinep);
 } /* cs_find */
 /*
-* PRIVATE: cs_find_common
+* Common code for cscope find, shared by cs_find() and ex_cstag().
-*
-* common code for cscope find, shared by cs_find() and do_cstag()
 */
 static int
 cs_find_common(
 char *opt,
 char *pat,
 }
 } /* cs_find_common */
 /*
-* PRIVATE: cs_help
+* Print help.
-*
-* print help
 */
 static int
 cs_help(exarg_T *eap UNUSED)
 {
 cscmd_T *cmdp = cs_cmds;
 return msg;
 }
 #endif
 /*
-* PRIVATE: cs_insert_filelist
+* Insert a new cscope database filename into the filelist.
-*
-* insert a new cscope database filename into the filelist
 */
 static int
 cs_insert_filelist(
 char *fname,
 char *ppath,
 return i;
 } /* cs_insert_filelist */
 /*
-* PRIVATE: cs_lookup_cmd
+* Find cscope command in command table.
-*
-* find cscope command in command table
 */
 static cscmd_T *
 cs_lookup_cmd(exarg_T *eap)
 {
 cscmd_T *cmdp;
 return NULL;
 } /* cs_lookup_cmd */
 /*
-* PRIVATE: cs_kill
+* Nuke em.
-*
-* nuke em
 */
 static int
 cs_kill(exarg_T *eap UNUSED)
 {
 char *stok;
 return 0;
 } /* cs_kill */
 /*
-* PRIVATE: cs_kill_execute
-*
 * Actually kills a specific cscope connection.
 */
 static void
 cs_kill_execute(
 int i,	    /* cscope table index */
 cs_release_csp(i, TRUE);
 }
 /*
-* PRIVATE: cs_make_vim_style_matches
+* Convert the cscope output into a ctags style entry (as might be found
-*
-* convert the cscope output into a ctags style entry (as might be found
 * in a ctags tags file).  there's one catch though: cscope doesn't tell you
 * the type of the tag you are looking for.  for example, in Darren Hiebert's
 * ctags (the one that comes with vim), #define's use a line number to find the
 * tag in a file while function definitions use a regexp search pattern.
 *
-* i'm going to always use the line number because cscope does something
+* I'm going to always use the line number because cscope does something
 * quirky (and probably other things i don't know about):
 *
 *     if you have "#  define" in your source file, which is
 *     perfectly legal, cscope thinks you have "#define".  this
 *     will result in a failed regexp search. :(
 *
-* besides, even if this particular case didn't happen, the search pattern
+* Besides, even if this particular case didn't happen, the search pattern
 * would still have to be modified to escape all the special regular expression
 * characters to comply with ctags formatting.
 */
 static char *
 cs_make_vim_style_matches(
 return buf;
 } /* cs_make_vim_style_matches */
 /*
-* PRIVATE: cs_manage_matches
+* This is kind of hokey, but i don't see an easy way round this.
-*
-* this is kind of hokey, but i don't see an easy way round this..
 *
 * Store: keep a ptr to the (malloc'd) memory of matches originally
 * generated from cs_find().  the matches are originally lines directly
 * from cscope output, but transformed to look like something out of a
 * ctags.  see cs_make_vim_style_matches for more details.
 return p;
 } /* cs_manage_matches */
 /*
-* PRIVATE: cs_parse_results
+* Parse cscope output.
-*
-* parse cscope output
 */
 static char *
 cs_parse_results(
 int cnumber,
 char *buf,
 return name;
 }
 #ifdef FEAT_QUICKFIX
 /*
-* PRIVATE: cs_file_results
+* Write cscope find results to file.
-*
-* write cscope find results to file
 */
 static void
 cs_file_results(FILE *f, int *nummatches_a)
 {
 int i, j;
 vim_free(buf);
 }
 #endif
 /*
-* PRIVATE: cs_fill_results
+* Get parsed cscope output and calls cs_make_vim_style_matches to convert
-*
+* into ctags format.
-* get parsed cscope output and calls cs_make_vim_style_matches to convert
-* into ctags format
 * When there are no matches sets "*matches_p" to NULL.
 */
 static void
 cs_fill_results(
 char *tagstr,
 	++s;
 return s;
 }
 /*
-* PRIVATE: cs_print_tags_priv
+* Called from cs_manage_matches().
-*
-* called from cs_manage_matches()
 */
 static void
 cs_print_tags_priv(char **matches, char **cntxts, int num_matches)
 {
 char	*buf = NULL;
 vim_free(buf);
 } /* cs_print_tags_priv */
 /*
-* PRIVATE: cs_read_prompt
+* Read a cscope prompt (basically, skip over the ">> ").
-*
-* read a cscope prompt (basically, skip over the ">> ")
 */
 static int
 cs_read_prompt(int i)
 {
 int		ch;
 SIGRETURN;
 }
 #endif
 /*
-* PRIVATE: cs_release_csp
-*
 * Does the actual free'ing for the cs ptr with an optional flag of whether
 * or not to free the filename.  Called by cs_kill and cs_reset.
 */
 static void
 cs_release_csp(int i, int freefnpp)
 clear_csinfo(i);
 } /* cs_release_csp */
 /*
-* PRIVATE: cs_reset
+* Calls cs_kill on all cscope connections then reinits.
-*
-* calls cs_kill on all cscope connections then reinits
 */
 static int
 cs_reset(exarg_T *eap UNUSED)
 {
 char	**dblist = NULL, **pplist = NULL, **fllist = NULL;
 return CSCOPE_SUCCESS;
 } /* cs_reset */
 /*
-* PRIVATE: cs_resolve_file
-*
 * Construct the full pathname to a file found in the cscope database.
 * (Prepends ppath, if there is one and if it's not already prepended,
 * otherwise just uses the name found.)
 *
 * We need to prepend the prefix because on some cscope's (e.g., the one that
 return fullname;
 }
 /*
-* PRIVATE: cs_show
+* Show all cscope connections.
-*
-* show all cscope connections
 */
 static int
 cs_show(exarg_T *eap UNUSED)
 {
 short i;
 return CSCOPE_SUCCESS;
 } /* cs_show */
 /*
-* PUBLIC: cs_end
-*
 * Only called when VIM exits to quit any cscope sessions.
 */
 void
 cs_end(void)
 {

Mercurial > vim

comparison src/if_cscope.c @ 10373:bd674706408a v8.0.0081