Beispiel #1
0
/*
 * Document specific function(s) in a file.
 * Call kernel-doc with the following parameters:
 * kernel-doc -docbook -function function1 [-function function2]
 */
static void singfunc(char * filename, char * line)
{
	char *vec[200]; /* Enough for specific functions */
	int i, idx = 0;
	int startofsym = 1;
	vec[idx++] = KERNELDOC;
	vec[idx++] = KERNELDOC_FORMAT;
	vec[idx++] = SHOWNOTFOUND;

	/* Split line up in individual parameters preceded by FUNCTION */
	for (i=0; line[i]; i++) {
		if (isspace(line[i])) {
			line[i] = '\0';
			startofsym = 1;
			continue;
		}
		if (startofsym) {
			startofsym = 0;
			vec[idx++] = FUNCTION;
			vec[idx++] = &line[i];
		}
	}
	for (i = 0; i < idx; i++) {
		if (strcmp(vec[i], FUNCTION))
			continue;
		consume_symbol(vec[i + 1]);
	}
	vec[idx++] = filename;
	vec[idx] = NULL;
	exec_kernel_doc(vec);
}
Beispiel #2
0
/*
 * Insert specific documentation section from a file.
 * Call kernel-doc with the following parameters:
 * kernel-doc -docbook -function "doc section" filename
 */
static void docsect(char *filename, char *line)
{
	/* kerneldoc -docbook -show-not-found -function "section" file NULL */
	char *vec[7];
	char *s;

	for (s = line; *s; s++)
		if (*s == '\n')
			*s = '\0';

	if (asprintf(&s, "DOC: %s", line) < 0) {
		perror("asprintf");
		exit(1);
	}
	consume_symbol(s);
	free(s);

	vec[0] = KERNELDOC;
	vec[1] = KERNELDOC_FORMAT;
	vec[2] = SHOWNOTFOUND;
	vec[3] = FUNCTION;
	vec[4] = line;
	vec[5] = filename;
	vec[6] = NULL;
	exec_kernel_doc(vec);
}
Beispiel #3
0
/*
 * Document all external or internal functions in a file.
 * Call kernel-doc with following parameters:
 * kernel-doc [-docbook|-rst] -nofunction function_name1 filename
 * Function names are obtained from all the src files
 * by find_export_symbols.
 * intfunc uses -nofunction
 * extfunc uses -function
 */
static void docfunctions(char * filename, char * type)
{
	int i,j;
	int symcnt = 0;
	int idx = 0;
	char **vec;

	for (i=0; i <= symfilecnt; i++)
		symcnt += symfilelist[i].symbolcnt;
	vec = malloc((2 + 2 * symcnt + 3) * sizeof(char *));
	if (vec == NULL) {
		perror("docproc: ");
		exit(1);
	}
	vec[idx++] = KERNELDOC;
	vec[idx++] = KERNELDOC_FORMAT;
	vec[idx++] = NODOCSECTIONS;
	for (i=0; i < symfilecnt; i++) {
		struct symfile * sym = &symfilelist[i];
		for (j=0; j < sym->symbolcnt; j++) {
			vec[idx++]     = type;
			consume_symbol(sym->symbollist[j].name);
			vec[idx++] = sym->symbollist[j].name;
		}
	}
	vec[idx++]     = filename;
	vec[idx] = NULL;
	if (file_format == FORMAT_RST)
		printf(".. %s\n", filename);
	else
		printf("<!-- %s -->\n", filename);
	exec_kernel_doc(vec);
	fflush(stdout);
	free(vec);
}
Beispiel #4
0
void top_level_consume_token(TokenizeContext &context)
{
    if (is_identifier_first_letter(context.next())) {

        if (context.next() <= 'm') {
            // a through m
            if (try_to_consume_keyword(context, tok_And)) return;
            if (try_to_consume_keyword(context, tok_Break)) return;
            if (try_to_consume_keyword(context, tok_Case)) return;
            if (try_to_consume_keyword(context, tok_Continue)) return;
            if (try_to_consume_keyword(context, tok_Def)) return;
            if (try_to_consume_keyword(context, tok_Discard)) return;
            if (try_to_consume_keyword(context, tok_Else)) return;
            if (try_to_consume_keyword(context, tok_Elif)) return;
            if (try_to_consume_keyword(context, tok_False)) return;
            if (try_to_consume_keyword(context, tok_For)) return;
            if (try_to_consume_keyword(context, tok_If)) return;
            if (try_to_consume_keyword(context, tok_In)) return;
            if (try_to_consume_keyword(context, tok_Import)) return;
            if (try_to_consume_keyword(context, tok_Include)) return;
            if (try_to_consume_keyword(context, tok_Let)) return;
        } else {
            // n through z
            if (try_to_consume_keyword(context, tok_Namespace)) return;
            if (try_to_consume_keyword(context, tok_Not)) return;
            if (try_to_consume_keyword(context, tok_Nil)) return;
            if (try_to_consume_keyword(context, tok_Or)) return;
            if (try_to_consume_keyword(context, tok_Return)) return;
            if (try_to_consume_keyword(context, tok_State)) return;
            if (try_to_consume_keyword(context, tok_Struct)) return;
            if (try_to_consume_keyword(context, tok_Switch)) return;
            if (try_to_consume_keyword(context, tok_True)) return;
            if (try_to_consume_keyword(context, tok_Require)) return;
            if (try_to_consume_keyword(context, tok_RequireLocal)) return;
            if (try_to_consume_keyword(context, tok_Package)) return;
            if (try_to_consume_keyword(context, tok_Section)) return;
            if (try_to_consume_keyword(context, tok_While)) return;
        }

        consume_identifier(context);
        return;
    }

    if (is_whitespace(context.next())) {
        consume_whitespace(context);
        return;
    }

    if (context.next() == '0'
        && context.next(1) == 'x') {
        consume_hex_number(context);
        return;
    }

    if (match_number(context)) {
        consume_number(context);
        return;
    }

    // Check for specific characters
    switch(context.next()) {
        case '(':
            context.consume(tok_LParen, 1);
            return;
        case ')':
            context.consume(tok_RParen, 1);
            return;
        case '{':
            if (context.next(1) == '-') {
                consume_multiline_comment(context);
                return;
            }
            context.consume(tok_LBrace, 1);
            return;
        case '}':
            context.consume(tok_RBrace, 1);
            return;
        case '[':
            context.consume(tok_LSquare, 1);
            return;
        case ']':
            context.consume(tok_RSquare, 1);
            return;
        case ',':
            context.consume(tok_Comma, 1);
            return;
        case '@':
            context.consume(tok_At, 1);
            return;
        case '=':
            if (context.next(1) == '=') {
                context.consume(tok_DoubleEquals, 2);
                return;
            }  else if (context.next(1) == '>') {
                context.consume(tok_FatArrow, 2);
                return;
            }

            context.consume(tok_Equals, 1);
            return;
        case '"':
        case '\'':
            consume_string_literal(context);
            return;
        case '\n':
            context.consume(tok_Newline, 1);
            return;
        case '.':
            if (context.next(1) == '.') {
                if (context.next(2) == '.') {
                    context.consume(tok_Ellipsis, 3); 
                } else {
                    context.consume(tok_TwoDots, 2);
                }
            } else if (context.next(1) == '@') {
                context.consume(tok_DotAt, 2);
            } else {
                context.consume(tok_Dot, 1);
            }
            return;
        case '?':
            context.consume(tok_Question, 1);
            return;
        case '*':
            if (context.next(1) == '=') {
                context.consume(tok_StarEquals, 2);
                return;
            }
            if (context.next(1) == '*') {
                context.consume(tok_DoubleStar, 2);
                return;
            }

            context.consume(tok_Star, 1);
            return;
        case '/':
            if (context.next(1) == '=') {
                context.consume(tok_SlashEquals, 2);
                return;
            }
            if (context.next(1) == '/') {
                context.consume(tok_DoubleSlash, 2);
                return;
            }
            context.consume(tok_Slash, 1);
            return;
        case '!':
            if (context.next(1) == '=') {
                context.consume(tok_NotEquals, 2);
                return;
            }
            break;

        case ':':
            if (context.next(1) == '=') {
                context.consume(tok_ColonEquals, 2);
                return;
            }
            else if (context.next(1) == ':') {
                context.consume(tok_DoubleColon, 2);
                return;
            } else if (is_acceptable_inside_identifier(context.next(1))) {
                return consume_symbol(context);
            }

            context.consume(tok_Colon, 1);
            return;
        case '+':
            if (context.next(1) == '=') {
                context.consume(tok_PlusEquals, 2);
            } else {
                context.consume(tok_Plus, 1);
            }
            return;
        case '-':
            if (context.next(1) == '>') {
                context.consume(tok_RightArrow, 2);
                return;
            }

            if (context.next(1) == '-')
                return consume_comment(context);

            if (context.next(1) == '=') {
                context.consume(tok_MinusEquals, 2);
                return;
            }

            context.consume(tok_Minus, 1);
            return;

        case '<':
            if (context.next(1) == '<' && context.next(2) == '<') {
                consume_triple_quoted_string_literal(context);
                return;
            }

            if (context.next(1) == '=') {
                context.consume(tok_LThanEq, 2);
                return;
            }
            if (context.next(1) == '-') {
                context.consume(tok_LeftArrow, 2);
                return;
            }
            context.consume(tok_LThan, 1);
            return;

        case '>':
            if (context.next(1) == '=')
                context.consume(tok_GThanEq, 2);
            else
                context.consume(tok_GThan, 1);
            return;

        case '%':
            context.consume(tok_Percent, 1);
            return;

        case '|':
            if (context.next(1) == '|')
                context.consume(tok_DoubleVerticalBar, 2);
            else
                context.consume(tok_VerticalBar, 1);
            return;

        case '&':
            if (context.next(1) == '&')
                context.consume(tok_DoubleAmpersand, 2);
            else
                context.consume(tok_Ampersand, 1);
            return;

        case ';':
            context.consume(tok_Semicolon, 1);
            return;

        case '#':
            consume_color_literal(context);
            return;
    }

    // Fall through, consume the next letter as UNRECOGNIZED
    context.consume(tok_Unrecognized, 1);
}