Support getfilePath api and handle same function identifier

[boy1583]

We used bin2cpp to process our SPA single page application resources in a folder (html\css\js).

We have two issues.

1. For the generation method in a folder, we can‘t get the path of the original file. So we created a new API called getFilePath in File class.
   E.g:

virtual const char * getFilename() const { return "app.4581e082.css"; }
virtual const char * getFilepath() const { return "static/css/app.4581e082.css"; }

2. call GetFilenameWithoutExtension double times in processInputDirectory, which causes the following files to be overwritten (both a.h):

static/js/A.123.js
static/css/A.456.css

We remove one GetFilenameWithoutExtension call in getFunctionIdentifierFromPath.

3. The following situation may lead to ths same function identifier (e.g. class A123), leading to compilation errors (redeclaration)

static/js/A.123.js
static/css/A.123.css

We use a map to save identifier times, which is solved by appending increase index, such as class A123_1 and class A123_2, although it is not very elegant.

[end2endzone]

Hi. Thank you for showing interest in bin2cpp. Apologize for the late response.

Regarding your first issue, I think it is a really good idea. I really like it.
The getFilePath() api call makes the function getFilename() not required anymore. However, it should be kept for backward compatibility reason.
I think we could also implement such functionality with a new filepath command line argument.
When specified, this path could be used to implement the getFilePath() api and the existing getFilename() api.
For example:

bin2cpp --noheader --override --file=static\css\A.123.css --headerfile=A_123.h --filepath="static\css\A.123.css" --output=.\outdir --identifier=A123 --managerfile=FileMgr.h --registerfile

When using --dir argument, the command could forward the actual related path "static\css\A.123.css" to the filepath argument.

---

I have looked more deeply about your second issue.
You are right, it seems to be a bug located in main.cpp, line 575.

We remove one GetFilenameWithoutExtension call in getFunctionIdentifierFromPath

I disagree with your proposed solution. In my opinion, based on its name, the function getFunctionIdentifierFromPath() is obviously expecting a file path instead of only a filename. I think I made an error in commit be71f9f when fixing #42 in which I renamed the function getIdentifier() to getFunctionIdentifierFromPath(). I think the solution would be to remove the call to GetFilenameWithoutExtension() on line 575 before calling getFunctionIdentifierFromPath(). In my preliminary tests, it seems to solve the issue.

---

The problem you mention at your third issue is easily resolved with the the fix explained above.
The correction gives the identifiers getA123File() and getA456File() generated from files A.123.js and A.456.css.

---

I am really happy that you found out about these problem.
I am also open to contribution. Would you like to implement the fixes?

1. Implement a --filepath command line that is used to specify the returned value when calling getFilePath() function.
2. Remove the call to GetFilenameWithoutExtension() on main.cpp, line 575.

I have looked at the changes in your forked repository. More specifically, at commit 02fbf0908e2fb9bc381608072a942bb9b53bdb08.
I think there are more changes than what is actually required.
If you would like to make the changes yourself and contribute to the project, please tell me so that I do not work on them.
If not, I am also fine and I will implement the feature in the next month.

[end2endzone]

I did not received feedback from you. I have looked at you commit in your fork repository. Like I said: "I think there are more changes than what is actually required".

I have now fixed new issues since your last commit and I do not think your original changes still applies. However, since this is your idea, I would like to give you the opportunity to contribute to this repository. Here is what I would propose for the new changes:

1. Update the public api with a new getFilePath() function. This change is exactly like you implemented here.
2. Implement a --reportedfilepath command line that is used to specify the returned value when calling getFilePath() function. Also modify ARGUMENTS structure.
3. Create new methods in BaseGenerator for storing the value specified with --filepath. I think the names you used (setFilePathInDir() and getFilePathInDir()) are not ideal. The problem is the Dir postfix. My point is that the option --reportedfilepath is also available when the user does not specify the --dir command line. In other words, if a user calls bin2cpp with --file and --reportedfilepath, using the postfix Dir is out of context. I think the names setReportedFilePath() and getReportedFilePath() are more appropriate. The names also matches the format setXXXFilePath() like setInputFilePath().
4. Modify the code so that when using --keepdirs, the code automatically implements --reportedfilepath.
5. Create unit tests to validate the new behavior.

I would be available to start working on these changes tomorrow. Please advise if you agree to make the changes. I you would prefer to not contribute, I am also fine with that.
Thank you.

[end2endzone]

Feature and documentation is completed.